diff options
Diffstat (limited to 'util/Doxygen_phpvarfilter.php')
-rw-r--r-- | util/Doxygen_phpvarfilter.php | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/util/Doxygen_phpvarfilter.php b/util/Doxygen_phpvarfilter.php new file mode 100644 index 000000000..da6cf1666 --- /dev/null +++ b/util/Doxygen_phpvarfilter.php @@ -0,0 +1,18 @@ +<?php +/** + * @file Doxygen_phpvarfilter.php + * @brief A Doxygen INPUT_FILTER to parse \@var member variable documentation. + * + * An input filter for Doxygen to parse \@var class member variable documentation, + * so it is a bit more compatible how anybody else interpretes it. + * + * @see http://stackoverflow.com/questions/4325224/doxygen-how-to-describe-class-member-variables-in-php/8472180#8472180 + */ + +$source = file_get_contents($argv[1]); + +$regexp = '#\@var\s+([^\s]+)([^/]+)/\s+(var|public|protected|private)\s+(\$[^\s;=]+)#'; +$replac = '${2} */ ${3} ${1} ${4}'; +$source = preg_replace($regexp, $replac, $source); + +echo $source; |