]> git.mxchange.org Git - friendica.git/commitdiff
Guesss what? Yeah, some documentation
authorMichael Vogel <icarus@dabo.de>
Mon, 28 Mar 2016 20:21:14 +0000 (22:21 +0200)
committerMichael Vogel <icarus@dabo.de>
Mon, 28 Mar 2016 20:21:14 +0000 (22:21 +0200)
util/createdoxygen.php [changed mode: 0755->0644]

old mode 100755 (executable)
new mode 100644 (file)
index d48114b..163c94b
@@ -1,5 +1,10 @@
 #!/usr/bin/php
 <?php
+/**
+ * @file util/createdoxygen.php
+ * @brief Adds a doxygen header to functions
+ */
+
 if (count($_SERVER["argv"]) < 2)
        die("usage: createdoxygen.php file\n");
 
@@ -45,6 +50,13 @@ foreach ($lines AS $line) {
        $previous = $line;
 }
 
+/**
+ * @brief Adds a doxygen header
+ *
+ * @param string $line The current line of the document
+ *
+ * @return string added doxygen header
+ */
 function add_documentation($line) {
 
        $trimmed = ltrim($line);