List of all members.
Detailed Description
Filter from perl syntax API docs to Doxygen-compatible syntax. This class is meant to be used as a filter for the Doxygen documentation tool.
Definition at line 12 of file PerlFilter.pm.
Member Function Documentation
| list SBIA::BASIS::DoxyGen::PerlFilter::analyze_sub |
( |
int |
line | ) |
|
analyzes a subroutine declaration starting at the given line. Tries to determine whicht arguments it takes.
- Parameters:
-
| line | The line number at which the sub starts |
- Returns:
- A function prototype, the name of the function and a list of arguments it takes
| SBIA::BASIS::DoxyGen::PerlFilter::emit_class |
( |
string |
class, |
|
|
int |
line, |
|
|
arrayref |
doc |
|
) |
| |
Emit one class definition. If the doc parameter is defined, emits the array as a comment just before the class definition, otherwise, only the class definition is emitted.
- Parameters:
-
| class | the name of the class |
| line | the current line number |
| doc | (optional) an array with comment lines |
| arrayref SBIA::BASIS::DoxyGen::PerlFilter::file_contents |
( |
arrayref |
contents | ) |
|
set/get an array containing the whole input file, each line at one array index.
- Parameters:
-
| contents | (optional) file array ref |
- Returns:
- The file array ref
| void SBIA::BASIS::DoxyGen::PerlFilter::filter |
( |
scalar |
infh | ) |
[virtual] |
| SBIA::BASIS::DoxyGen::PerlFilter::munge_parameters |
( |
scalar |
args | ) |
|
Munge the argument list. Because DoxyGen does not seem to handle $, @ and % as argument types properly, we replace them with full length strings.
- Parameters:
-
| args | String specifying anything after a directive |
- Returns:
- Processed string.
The documentation for this class was generated from the following file:
Inheritance diagram for SBIA::BASIS::DoxyGen::PerlFilter:
