bitPickups/friendica_2019-12_sharedHosting_hotFix
1
1
Fork 0
Code Pull requests Activity

Guesss what? Yeah, some documentation

Browse source
This commit is contained in:
Michael Vogel 2016-03-28 22:21:14 +02:00
parent b6121a0009
commit 3c24f43011
1 changed files with 12 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
util/createdoxygen.php Executable file → Normal file
View file

@ -1,5 +1,10 @@
#!/usr/bin/php #!/usr/bin/php
<?php <?php
/**
* @file util/createdoxygen.php
* @brief Adds a doxygen header to functions
*/
if (count($_SERVER["argv"]) < 2) if (count($_SERVER["argv"]) < 2)
die("usage: createdoxygen.php file\n"); die("usage: createdoxygen.php file\n");
@ -45,6 +50,13 @@ foreach ($lines AS $line) {
$previous = $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) { function add_documentation($line) {
$trimmed = ltrim($line); $trimmed = ltrim($line);