Guesss what? Yeah, some documentation

This commit is contained in:
Michael Vogel 2016-03-28 22:21:14 +02:00 committed by Roland Haeder
parent a7f656c041
commit 0e74dc6db3
No known key found for this signature in database
GPG key ID: B72F8185C6C7BD78

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);