Added script that will create the documentation.

Also rewritten some documentation, so NaturalDocs can handle them.

6 files changed, 48 insertions, 41 deletions

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..486103b
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,2 @@
+docu
+naturaldocs_dir
diff --git a/make_docu.sh b/make_docu.sh
new file mode 100755
index 0000000..37c0210
--- /dev/null
+++ b/make_docu.sh
@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+if ! [ -d docu ]; then mkdir docu; fi
+if ! [ -d naturaldocs_dir ]; then mkdir naturaldocs_dir; fi
+NaturalDocs -i . -o HTML docu -p naturaldocs_dir/
diff --git a/ratatoeskr/sys/db.php b/ratatoeskr/sys/db.php
index 0f3357a..fcde7f3 100644
--- a/ratatoeskr/sys/db.php
+++ b/ratatoeskr/sys/db.php
@@ -40,6 +40,7 @@ function sqlesc($str)
 
 /*
  * 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 13d5843..f2f6076 100644
--- a/ratatoeskr/sys/models.php
+++ b/ratatoeskr/sys/models.php
@@ -14,6 +14,12 @@ require_once(dirname(__FILE__) . "/utils.php");
 db_connect();
 
 /*
+ * Variable: $ratatoeskr_settings
+ * The global <Settings> object. For internal use.
+ */
+$ratatoeskr_settings = new Settings("rw");
+
+/*
  * Class: DoesNotExistError
  * This Exception is thrown by an ::by_*-constructor or any array-like object if the desired object is not present in the database.
  */
@@ -892,12 +898,6 @@ class Settings implements Countable, ArrayAccess, IteratorAggregate
 }
 
 /*
- * Variable: $ratatoeskr_settings
- * The global <Settings> object. For internal use.
- */
-$ratatoeskr_settings = new Settings("rw");
-
-/*
  * Class: PluginKVStorage
  * A Key-Value-Storage for Plugins
  * Can be accessed like an array.
diff --git a/ratatoeskr/sys/plugin_api.php b/ratatoeskr/sys/plugin_api.php
index e5625f8..697c375 100644
--- a/ratatoeskr/sys/plugin_api.php
+++ b/ratatoeskr/sys/plugin_api.php
@@ -11,6 +11,21 @@
 
 require_once(dirname(__FILE__) . "/models.php");
 
+$url_handlers = array();
+/*
+ * Function: register_url_handler
+ * Register an URL handler. See <urlprocess.php> for more details.
+ * 
+ * Parameters:
+ * 	$name - The name of the new URL
+ * 	$callback - The Function to be called (see <url_process>).
+ */
+function register_url_handler($name, $callback)
+{
+	global $url_handlers;
+	$url_handlers[$name] = $callback;
+}
+
 /*
  * Class: RatatoeskrPlugin
  * An abstract class to be extended in order to write your own Plugin.
@@ -84,19 +99,4 @@ abstract class RatatoeskrPlugin
 	public function uninstall() {}
 }
 
-$url_handlers = array();
-/*
- * Function: register_url_handler
- * Register an URL handler. See <urlprocess.php> for more details.
- * 
- * Parameters:
- * 	$name - The name of the new URL
- * 	$callback - The Function to be called (see <url_process>).
- */
-function register_url_handler($name, $callback)
-{
-	global $url_handlers;
-	$url_handlers[$name] = $callback;
-}
-
 ?>
diff --git a/ratatoeskr/sys/urlprocess.php b/ratatoeskr/sys/urlprocess.php
index 2274197..d539c87 100644
--- a/ratatoeskr/sys/urlprocess.php
+++ b/ratatoeskr/sys/urlprocess.php
@@ -10,26 +10,6 @@
  */
 
 /*
- * Class: Redirect
- * Exception that can be thrown inside an <url_action_simple>.
- * throw new Redirect(array("..", "foo")); will redirect to "../foo" and won't touch $data.
- */
-class Redirect extends Exception
-{
-	public $nextpath;
-	public function __construct($nextpath)
-	{
-		$this->nextpath = $nextpath;
-		parent::__construct();
-	}
-}
-/*
- * Class: NotFoundError
- * An Exception
- */
-class NotFoundError extends Exception { }
-
-/*
  * Function: url_action_simple
  * Generate an action in a more simple way.
  * 
@@ -151,4 +131,24 @@ function url_process($url, $actions, &$data)
 		return NULL;
 }
 
+/*
+ * Class: Redirect
+ * Exception that can be thrown inside an <url_action_simple>.
+ * throw new Redirect(array("..", "foo")); will redirect to "../foo" and won't touch $data.
+ */
+class Redirect extends Exception
+{
+	public $nextpath;
+	public function __construct($nextpath)
+	{
+		$this->nextpath = $nextpath;
+		parent::__construct();
+	}
+}
+/*
+ * Class: NotFoundError
+ * An Exception
+ */
+class NotFoundError extends Exception { }
+
 ?>