    |
 | DoxyFilt: Doxygen::Filter Class Reference |
Doxygen::Filter Class Reference
Base class for Doxygen filter classes. More...
Inheritance diagram for Doxygen::Filter:
Public Member Functions | |
| new (%flags) | |
| Constructor for Doxygen::Filter objects. | |
| parse ($text, $target) | |
| Parse source text. | |
| parseCmnts ($text, $source) | |
| Parse comments from a source file. | |
| massage () | |
| Massage items in file after parsing and before generating. | |
| coding (@@text) | |
| Queue up a line of code to be shown in a box. | |
| codeFlush () | |
| Flush all pending code lines. | |
| flags () | |
| Return reference to flags hash for filter. | |
| focus () | |
| Return the current focus for adding comment lines. | |
| statistics ($source) | |
| Show simple statistics where available. | |
Detailed Description
Base class for Doxygen filter classes.
SYNOPSIS
Inherited by subclass:
use base qw(Doxygen::Filter);
Used in DoxyFilt.pl:
ABSTRACT
Provides 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++.
DESCRIPTION
SEE ALSO
COPYRIGHT AND LICENSE
Copyright 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.
- Version:
- '0.01'
- Author:
- Marc M. Adkins,
mailto:Perl@Doorways.org
Definition at line 49 of file Filter.pm.
Member Function Documentation
| Doxygen::Filter::codeFlush | ( | ) |
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.
| Doxygen::Filter::coding | ( | @@ | text | ) |
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.
- Parameters:
-
@text Lines of code to be queued.
| Doxygen::Filter::flags | ( | ) |
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.
| Doxygen::Filter::focus | ( | ) |
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.
- Returns:
- A Doxygen::Item object.
| Doxygen::Filter::massage | ( | ) |
Massage items in file after parsing and before generating.
Each filter may have a massage method and/or a parse method. The order of parsing and massaging is undefined except that all parsing will complete prior to any massaging being done.
This method is the default and therefore does nothing.
| Doxygen::Filter::new | ( | % | flags | ) |
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.
- Parameters:
-
%flags Flags used in object creation
Reimplemented in Doxygen::Perl::Filter.
| Doxygen::Filter::parse | ( | $ | text, | |
| $ | target | |||
| ) |
Parse source text.
Pick out whatever is important for the language or source type. Collect information on Doxygen::Filter object passed in as the $filter argument.
Returns true if parsing was successful, otherwise undef or die.
- Parameters:
-
$text text of entire file, passed by value so it is copied and can be mutilated as necessary by the filter \$target target object for parsing results, which are Doxygen::Item instances
Reimplemented in Doxygen::Perl::Filter, Doxygen::POD::Filter, and Doxygen::Script::Filter.
| Doxygen::Filter::parseCmnts | ( | $ | text, | |
| $ | source | |||
| ) |
Parse comments from a source file.
Attach results (Doxygen::Item objects) to Doxygen::Source object.
| Doxygen::Filter::statistics | ( | $ | source | ) |
Show simple statistics where available.
The documentation for this class was generated from the following file:
- Filter/Filter.pm
Generated on Mon Dec 27 2010 15:15:39 for DoxyFilt by
1.7.1 