Merge pull request #4214 from annando/fix-silence

[friendica.git] / util / createdoxygen.php

diff --git a/util/createdoxygen.php b/util/createdoxygen.php
index d48114b6716bb73a0b6ba4759c1aae8ffa9f4c34..798c81474f013062a2fef8cbde2f8d98e12867c3 100755 (executable)
--- a/util/createdoxygen.php
+++ b/util/createdoxygen.php
@@ -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);
@@ -79,4 +91,3 @@ function add_documentation($line) {
 
        return $block;
 }
-?>