|
BASIS
r3148
|
Base class for Doxygen filter implementations. More...
#include "Exporter.pm"
Include dependency graph for DoxyFilter.pm:
Go to the source code of this file.
Functions | |
| sub | _append () |
| Append line to output. | |
| sub | _doxydoc_begin () |
| Start of Doxygen comment. | |
| sub | _doxydoc_comment () |
| Doxygen comment line. | |
| sub | _doxydoc_end () |
| End of Doxygen comment. | |
| sub | _doxydoc_param () |
| Doxygen parameter documentation. | |
| sub | _doxydoc_returns () |
| Doxygen return value documentation. | |
| sub | _noneblank () |
| Handle none-blank line. | |
| sub | new () |
| Constructs a Doxygen filter object. | |
| sub | output () |
| Get filter output. | |
| sub | process () |
| Process input file. | |
Detailed Description
Base class for Doxygen filter implementations.
- Note:
- Not to confuse with the Doxygen::Filter::Perl package available on CPAN.
Copyright (c) 2012 University of Pennsylvania. All rights reserved. See https://www.cbica.upenn.edu/sbia/software/license.html or COPYING file.
Contact: SBIA Group <sbia-software at uphs.upenn.edu>
Definition in file DoxyFilter.pm.
Function Documentation
| sub _append | ( | ) |
Append line to output.
| sub _doxydoc_begin | ( | ) |
Start of Doxygen comment.
| sub _doxydoc_comment | ( | ) |
Doxygen comment line.
| sub _doxydoc_end | ( | ) |
End of Doxygen comment.
| sub _doxydoc_param | ( | ) |
Doxygen parameter documentation.
The documentation lines which document function/method/macro parameters are extracted and the information stored in the filter object. These parameter documentations can then be used by the particular Doxygen filter to generate a proper parameter list in case of languages which do by themselves not explicitly specify the type and name of the function parameters such as in Perl and Bash, in particular. Moreover, CMake provides the special ARGN parameter which stores all additional unnamed arguments.
| sub _doxydoc_returns | ( | ) |
Doxygen return value documentation.
This function simply records in the 'returndoc' member of the filter that a "@returns" or "\returns" Doxygen is present in the current Doxygen comment. Some filters such as the one for CMake or Bash, use a pseudo return type which indicates the type of the function rather than the actual type of a return value. Often these functions do not return any particular value. In this case, if the Doxygen comment does not include a documentation for the pseudo return value, Doxygen will warn. To avoid this warning, a standard documentation for the pseudo return value may be added by the filter.
| sub _noneblank | ( | ) |
Handle none-blank line.
This action inserts a dummy class definition which is ignored by Doxygen if the previous block was a Doxygen comment that is not associated with any following declaration. Otherwise, another transition would have handled this declaration before.
| sub new | ( | ) |
Constructs a Doxygen filter object.
| sub output | ( | ) |
Get filter output.
| sub process | ( | ) |
Process input file.