From f7192d05ab4afafdd91c517b4c3fd6329a3c3a24 Mon Sep 17 00:00:00 2001
From: Kevin Chabowski <kevin@kch42.de>
Date: Thu, 18 Aug 2011 17:45:40 +0200
Subject: Improved documentation.

---
 ratatoeskr/main.php           |  5 +++--
 ratatoeskr/sys/db.php         | 17 +++++++++--------
 ratatoeskr/sys/models.php     |  5 +++--
 ratatoeskr/sys/plugin_api.php |  8 ++++----
 ratatoeskr/sys/urlprocess.php |  5 +++--
 ratatoeskr/sys/utils.php      |  5 +++--
 6 files changed, 25 insertions(+), 20 deletions(-)

diff --git a/ratatoeskr/main.php b/ratatoeskr/main.php
index 93cefe5..8d988da 100644
--- a/ratatoeskr/main.php
+++ b/ratatoeskr/main.php
@@ -1,8 +1,9 @@
 <?php
 /*
- * File: main.php
+ * File: ratatoeskr/main.php
  * Initialize and launch Ratatöskr
- *
+ * 
+ * License:
  * This file is part of Ratatöskr.
  * Ratatöskr is licensed unter the MIT / X11 License.
  * See "ratatoeskr/licenses/ratatoeskr" for more information.
diff --git a/ratatoeskr/sys/db.php b/ratatoeskr/sys/db.php
index fcde7f3..55801c0 100644
--- a/ratatoeskr/sys/db.php
+++ b/ratatoeskr/sys/db.php
@@ -1,9 +1,10 @@
 <?php
 /*
- * File: db.php
+ * File: ratatoeskr/sys/db.php
  * 
  * Helper functions for dealing with MySQL.
- *
+ * 
+ * License:
  * This file is part of Ratatöskr.
  * Ratatöskr is licensed unter the MIT / X11 License.
  * See "ratatoeskr/licenses/ratatoeskr" for more information.
@@ -38,12 +39,6 @@ function sqlesc($str)
 	return mysql_real_escape_string($str);
 }
 
-/*
- * Class: MySQLException
- * Will be thrown by qdb*, if the query induced an MySQL error.
- */
-class MySQLException extends Exception { }
-
 /*
  * Function: qdb_vfmt
  * Like <qdb_fmt>, but needs arguments as single array. 
@@ -101,4 +96,10 @@ function qdb()
 	return $rv;
 }
 
+/*
+ * Class: MySQLException
+ * Will be thrown by qdb*, if the query induced an MySQL error.
+ */
+class MySQLException extends Exception { }
+
 ?>
diff --git a/ratatoeskr/sys/models.php b/ratatoeskr/sys/models.php
index f2f6076..4448266 100644
--- a/ratatoeskr/sys/models.php
+++ b/ratatoeskr/sys/models.php
@@ -1,8 +1,9 @@
 <?php
 /*
- * File: models.php
+ * File: ratatoeskr/sys/models.php
  * Data models to make database accesses more comfortable.
- *
+ * 
+ * License:
  * This file is part of Ratatöskr.
  * Ratatöskr is licensed unter the MIT / X11 License.
  * See "ratatoeskr/licenses/ratatoeskr" for more information.
diff --git a/ratatoeskr/sys/plugin_api.php b/ratatoeskr/sys/plugin_api.php
index 697c375..65e4c9c 100644
--- a/ratatoeskr/sys/plugin_api.php
+++ b/ratatoeskr/sys/plugin_api.php
@@ -1,9 +1,9 @@
 <?php
 /*
- * File: plugin_api.php
- * 
+ * File: ratatoeskr/sys/plugin_api.php
  * Plugin API contains the plugin base class and other interfaces to Ratatöskr.
- *
+ * 
+ * License:
  * This file is part of Ratatöskr.
  * Ratatöskr is licensed unter the MIT / X11 License.
  * See "ratatoeskr/licenses/ratatoeskr" for more information.
@@ -14,7 +14,7 @@ require_once(dirname(__FILE__) . "/models.php");
 $url_handlers = array();
 /*
  * Function: register_url_handler
- * Register an URL handler. See <urlprocess.php> for more details.
+ * Register an URL handler. See <ratatoeskr/sys/urlprocess.php> for more details.
  * 
  * Parameters:
  * 	$name - The name of the new URL
diff --git a/ratatoeskr/sys/urlprocess.php b/ratatoeskr/sys/urlprocess.php
index d539c87..a05d694 100644
--- a/ratatoeskr/sys/urlprocess.php
+++ b/ratatoeskr/sys/urlprocess.php
@@ -1,9 +1,10 @@
 <?php
 /*
- * File: urlprocess.php
+ * File: ratatoeskr/sys/urlprocess.php
  * 
  * Providing functions / classes to handle URLs
- *
+ * 
+ * License:
  * This file is part of Ratatöskr.
  * Ratatöskr is licensed unter the MIT / X11 License.
  * See "ratatoeskr/licenses/ratatoeskr" for more information.
diff --git a/ratatoeskr/sys/utils.php b/ratatoeskr/sys/utils.php
index de673aa..5e132f4 100644
--- a/ratatoeskr/sys/utils.php
+++ b/ratatoeskr/sys/utils.php
@@ -1,9 +1,10 @@
 <?php
 /*
- * File: utils.php
+ * File: ratatoeskr/sys/utils.php
  * 
  * Various useful helper functions.
- *
+ * 
+ * License:
  * This file is part of Ratatöskr.
  * Ratatöskr is licensed unter the MIT / X11 License.
  * See "ratatoeskr/licenses/ratatoeskr" for more information.
-- 
cgit v1.2.3-54-g00ecf