add documentation

diff --git a/boot.php b/boot.php
index a51b7a42bdedf2e5f62469e9510651ac87b2f58e..4e6c9cf21416f1a7dead2e57917d73e300683706 100644 (file)
--- a/boot.php
+++ b/boot.php
@@ -1961,11 +1961,21 @@ function current_load() {
        return max($load_arr);
 }
 
-// much better way of dealing with c-style args
+/**
+ * @brief get c-style args
+ * 
+ * @return int
+ */
 function argc() {
        return get_app()->argc;
 }
 
+/**
+ * @brief Returns the value of a argv key
+ * 
+ * @param int $x argv key
+ * @return string Value of the argv key
+ */
 function argv($x) {
        if(array_key_exists($x,get_app()->argv))
                return get_app()->argv[$x];

diff --git a/mod/help.php b/mod/help.php
index ebade07ea77e4cff7f6615a9cf9e198f591e75fe..974577876d4c4dc4709ca984f0bcf84934e0b270 100644 (file)
--- a/mod/help.php
+++ b/mod/help.php
@@ -28,6 +28,8 @@ function help_content(&$a) {
 
        if ($a->argc > 1) {
                $path = '';
+               // looping through the argv keys bigger than 0 to build
+               // a path relative to /help
                for($x = 1; $x < argc(); $x ++) {
                        if(strlen($path))
                                $path .= '/';