aboutsummaryrefslogtreecommitdiff
path: root/ratatoeskr
diff options
context:
space:
mode:
authorKevin Chabowski <kevin@kch42.de>2011-08-18 17:45:40 +0200
committerKevin Chabowski <kevin@kch42.de>2011-08-18 17:45:40 +0200
commitf7192d05ab4afafdd91c517b4c3fd6329a3c3a24 (patch)
treef2e5bfe181a739ef005325ceba8d26983debea73 /ratatoeskr
parent49d251000e2a280b4feb42d33750b00edca2c543 (diff)
downloadratatoeskr-cms-f7192d05ab4afafdd91c517b4c3fd6329a3c3a24.tar.gz
ratatoeskr-cms-f7192d05ab4afafdd91c517b4c3fd6329a3c3a24.tar.bz2
ratatoeskr-cms-f7192d05ab4afafdd91c517b4c3fd6329a3c3a24.zip
Improved documentation.
Diffstat (limited to 'ratatoeskr')
-rw-r--r--ratatoeskr/main.php5
-rw-r--r--ratatoeskr/sys/db.php17
-rw-r--r--ratatoeskr/sys/models.php5
-rw-r--r--ratatoeskr/sys/plugin_api.php8
-rw-r--r--ratatoeskr/sys/urlprocess.php5
-rw-r--r--ratatoeskr/sys/utils.php5
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.
@@ -39,12 +40,6 @@ function sqlesc($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.