From: Michael Vogel <icarus@dabo.de>
Date: Mon, 28 Mar 2016 20:21:14 +0000 (+0200)
Subject: Guesss what? Yeah, some documentation
X-Git-Url: https://git.mxchange.org/?a=commitdiff_plain;h=3c24f43011b3f00bf1ee6e494f2af2d06cd68b51;p=friendica.git

Guesss what? Yeah, some documentation
---

diff --git a/util/createdoxygen.php b/util/createdoxygen.php
old mode 100755
new mode 100644
index d48114b671..163c94bb97
--- 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);