|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Doxygen::Filter Class ReferenceBase class for Doxygen filter classes. More... Inheritance diagram for Doxygen::Filter:
Detailed DescriptionBase class for Doxygen filter classes. SYNOPSISInherited by subclass: use base qw(Doxygen::Filter); Used in DoxyFilt.pl: ABSTRACTProvides a root class for a source filter for the Doxygen documentation tool. This class should be inherited by source-specific subclasses, which will in turn be used by the DoxyFilt.pl script, called by the Doxygen program to process source files other than C and C++. DESCRIPTIONSEE ALSOCOPYRIGHT AND LICENSECopyright 2004-2010 by Marc M. Adkins This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
Definition at line 49 of file Filter.pm. Member Function Documentation
Flush all pending code lines. Code lines are collected via the coding() method. This method is called to flush the collected lines in a marked block and clear the collection mechanism.
Queue up a line of code to be shown in a box. Lines of code are collected prior to output. This method collects then, the codeFlush() method flushes them as output for doxygen.
Return reference to flags hash for filter. In general these will be flag default values, and could be set as a class method. However, it is easier to code this as an instance method, and may lend itself to other weirdness later on that account. The default version returns an empty hash reference. Filters intending to use this must overload it.
Return the current focus for adding comment lines. Defaults to the value for the current source entity, but may be overridden by descendant classes modelling language-specific documentation entities.
Massage items in file after parsing and before generating. Each filter may have a This method is the default and therefore does nothing.
Constructor for Doxygen::Filter objects. Collects the flags as a hash and blesses a reference there, making it easy to set up initial field values.
Reimplemented in Doxygen::Perl::Filter.
Parse source text. Pick out whatever is important for the language or source type. Collect information on Doxygen::Filter object passed in as the Returns true if parsing was successful, otherwise undef or die.
Reimplemented in Doxygen::Perl::Filter, Doxygen::POD::Filter, and Doxygen::Script::Filter.
Parse comments from a source file. Attach results (
Show simple statistics where available. The documentation for this class was generated from the following file:
Generated on Mon Dec 27 2010 15:15:39 for DoxyFilt by 1.7.1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||


Inheritance diagram for Doxygen::Filter: