From 3fdfec38c023a886f5669b6ccfae1c4603784d8b Mon Sep 17 00:00:00 2001
From: Timothy Warren <tim@timshomepage.net>
Date: Mon, 9 Jan 2012 10:32:52 -0500
Subject: [PATCH] Better comments in core files, added dbad-license

---
 index.php       | 16 +++++++++++++++-
 sys/common.php  | 14 ++++++++++++++
 sys/db.php      | 19 +++++++++++++++++--
 sys/miniMVC.php | 24 ++++++++++++++++++++++++
 sys/output.php  | 17 +++++++++++++++++
 sys/page.php    | 16 ++++++++++++++--
 6 files changed, 101 insertions(+), 5 deletions(-)

diff --git a/index.php b/index.php
index 13b9b9d..137ebd3 100644
--- a/index.php
+++ b/index.php
@@ -1,4 +1,16 @@
 <?php
+/**
+ * MiniMVC
+ *
+ * Convention-based micro-framework for PHP
+ *
+ * @author 		Timothy J. Warren
+ * @copyright	Copyright (c) 2011 - 2012
+ * @link 		https://github.com/timw4mail/miniMVC
+ * @license 	http://philsturgeon.co.uk/code/dbad-license 
+ */
+
+// --------------------------------------------------------------------------
 
 // Change this in a live environment!
 error_reporting((-1) & ~(E_ERROR | E_PARSE));
@@ -26,4 +38,6 @@ set_error_handler('on_error');
 set_exception_handler('on_exception');
 
 // And away we go!
-route();
\ No newline at end of file
+route();
+
+// End of index.php 
\ No newline at end of file
diff --git a/sys/common.php b/sys/common.php
index cf8d99d..76cbb5a 100644
--- a/sys/common.php
+++ b/sys/common.php
@@ -1,8 +1,22 @@
 <?php
+/**
+ * MiniMVC
+ *
+ * Convention-based micro-framework for PHP
+ *
+ * @author 		Timothy J. Warren
+ * @copyright	Copyright (c) 2011 - 2012
+ * @link 		https://github.com/timw4mail/miniMVC
+ * @license 	http://philsturgeon.co.uk/code/dbad-license 
+ */
+
+// --------------------------------------------------------------------------
 
 /**
  * File including common framework-wide functions
  */
+ 
+// --------------------------------------------------------------------------
 
 /**
  * Function to run on script shutdown
diff --git a/sys/db.php b/sys/db.php
index 00ecc4e..b662c90 100644
--- a/sys/db.php
+++ b/sys/db.php
@@ -1,6 +1,21 @@
-<?php 
+<?php
 /**
- * Just for giggles extend PHP's PDO class
+ * MiniMVC
+ *
+ * Convention-based micro-framework for PHP
+ *
+ * @author 		Timothy J. Warren
+ * @copyright	Copyright (c) 2011 - 2012
+ * @link 		https://github.com/timw4mail/miniMVC
+ * @license 	http://philsturgeon.co.uk/code/dbad-license 
+ */
+ 
+// --------------------------------------------------------------------------
+ 
+/**
+ * Extend PHP's PDO class to add some more functionality
+ *
+ * @extends PDO
  */
 class db extends PDO {
 
diff --git a/sys/miniMVC.php b/sys/miniMVC.php
index 2530e12..6c4b301 100644
--- a/sys/miniMVC.php
+++ b/sys/miniMVC.php
@@ -1,4 +1,16 @@
 <?php
+/**
+ * MiniMVC
+ *
+ * Convention-based micro-framework for PHP
+ *
+ * @author 		Timothy J. Warren
+ * @copyright	Copyright (c) 2011 - 2012
+ * @link 		https://github.com/timw4mail/miniMVC
+ * @license 	http://philsturgeon.co.uk/code/dbad-license 
+ */
+
+// --------------------------------------------------------------------------
 
 /**
  * Parent class of base class, contains much of the magic
@@ -132,6 +144,8 @@ class JSObject {
 
 /**
  * Base class for the framework
+ *
+ * @extends JSObject
  */
 class miniMVC extends JSObject{
 
@@ -285,6 +299,11 @@ class miniMVC extends JSObject{
 
 // --------------------------------------------------------------------------
 
+/**
+ * Base Controller Class
+ *
+ * @extends miniMVC
+ */
 class MM_Controller extends miniMVC {
 
 	function __construct()
@@ -390,6 +409,11 @@ class MM_Controller extends miniMVC {
 
 // --------------------------------------------------------------------------
 
+/**
+ * Base Model Class
+ *
+ * @extends miniMVC
+ */
 class MM_Model extends miniMVC {
 
 	function __construct()
diff --git a/sys/output.php b/sys/output.php
index 26491ec..7bd679a 100644
--- a/sys/output.php
+++ b/sys/output.php
@@ -1,5 +1,22 @@
 <?php
+/**
+ * MiniMVC
+ *
+ * Convention-based micro-framework for PHP
+ *
+ * @author 		Timothy J. Warren
+ * @copyright	Copyright (c) 2011 - 2012
+ * @link 		https://github.com/timw4mail/miniMVC
+ * @license 	http://philsturgeon.co.uk/code/dbad-license 
+ */
 
+// --------------------------------------------------------------------------
+
+/**
+ * Class for displaying output and setting http headers
+ *
+ * @extends miniMVC
+ */
 class Output extends miniMVC {
 
 	private $buffer, $headers;
diff --git a/sys/page.php b/sys/page.php
index 96dfa48..4dc09a2 100644
--- a/sys/page.php
+++ b/sys/page.php
@@ -1,10 +1,22 @@
 <?php
+/**
+ * MiniMVC
+ *
+ * Convention-based micro-framework for PHP
+ *
+ * @author 		Timothy J. Warren
+ * @copyright	Copyright (c) 2011 - 2012
+ * @link 		https://github.com/timw4mail/miniMVC
+ * @license 	http://philsturgeon.co.uk/code/dbad-license 
+ */
+ 
+// --------------------------------------------------------------------------
 
 /**
  * Class for building pages
  *
  * All methods are chainable, with the exception of the constructor,
- * build_header(), build_footer(), build_page() and _headers() methods.
+ * build_header(), build_footer(), and _headers() methods.
  */
 class Page
 {
@@ -491,4 +503,4 @@ class Page
 	}
 }
 
-// End of page.php
+// End of page.php
\ No newline at end of file