    |
 | DoxyFilt: Doxygen::POD::Item Class Reference |
Doxygen::POD::Item Class Reference
Perl extension for generating Doxygen documentation. More...
Inheritance diagram for Doxygen::POD::Item:
Classes | |
| class | Over |
| Perl extension for generating Doxygen documentation. More... | |
Public Member Functions | |
| massage ($source) | |
| Convert all the comment text in this block from POD formatting sequences into Doxygen formatting sequences. | |
| generate (%flags) | |
| Generates output understandable by doxygen to standard output. | |
| _doxify_ ($source, $text) | |
| Convert POD escape sequences to HTML escape sequences. | |
| _escape_ () | |
| _glom_ () | |
| _linkage_ () | |
| _spaces_ () | |
Detailed Description
Perl extension for generating Doxygen documentation.
SYNOPSIS
my $item = new Doxygen::POD::Item;
ABSTRACT
A simple item in a POD source file.
DESCRIPTION
SEE ALSO
COPYRIGHT AND LICENSE
Copyright 2004 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 46 of file Item.pm.
Member Function Documentation
| Doxygen::POD::Item::_doxify_ | ( | $ | source, | |
| $ | text | |||
| ) |
| Doxygen::POD::Item::_escape_ | ( | ) |
| Doxygen::POD::Item::_glom_ | ( | ) |
| Doxygen::POD::Item::_linkage_ | ( | ) |
| Doxygen::POD::Item::_spaces_ | ( | ) |
| Doxygen::POD::Item::generate | ( | % | flags | ) |
Generates output understandable by doxygen to standard output.
Reimplemented from Doxygen::Item.
Reimplemented in Doxygen::POD::Item::Code, Doxygen::POD::Item::Format, Doxygen::POD::Item::Head, and Doxygen::POD::Item::Over.
| Doxygen::POD::Item::massage | ( | $ | source | ) |
Convert all the comment text in this block from POD formatting sequences into Doxygen formatting sequences.
- filename
filename.txt- italics
- italicized
- boldface
- boldface
- fixed pitch
typewriter- special characters
- Numeric characters '1', '2', 'E<0x33>>'. Named characters '<', '>', '/', '|', '&'.
- spaces
- Non-breaking spacing: good boys drink milk until it comes out of their ears.
- null sequence
- Dreaded 'Z' sequence: B<null>.
- links
- simple, more|complex, to/section, more I<complex yet|linkage>, text|/local, http://www.web.link/somewhere.htm.
Reimplemented from Doxygen::Item.
Reimplemented in Doxygen::POD::Item::Code.
The documentation for this class was generated from the following file:
- POD/Item/Item.pm
Generated on Mon Dec 27 2010 15:15:39 for DoxyFilt by
1.7.1 