    |
 | DoxyFilt: Doxygen::POD::Item::Over Class Reference |
Doxygen::POD::Item::Over Class Reference
Perl extension for generating Doxygen documentation. More...
Inheritance diagram for Doxygen::POD::Item::Over:
Public Member Functions | |
| generate (%flags) | |
| Generates output understandable by doxygen to standard output. | |
Detailed Description
Perl extension for generating Doxygen documentation.
SYNOPSIS
my $item = new Doxygen::POD::Item::Over;
ABSTRACT
A block of source code in a POD source file.
DESCRIPTION
Represents a list of items which is indented in the displayed format. Provides three choices:
- Bulleted
- Numbered
- Named definitions
This has three advantages:
- First advantage
- Second advantage
- Third advantage
SEE ALSO
DoxyFilt.pl Doxygen::Item Doxygen::POD::Item
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 69 of file Over.pm.
Member Function Documentation
| Doxygen::POD::Item::Over::generate | ( | % | flags | ) |
Generates output understandable by doxygen to standard output.
In order to determine what type of list to generate, it is necessary to look at all of the contained items and figure out how they are supposed to be displayed. There are three cases we recognize:
TYPE_BULLET- The items in the list are bulleted. This corresponds to HTML
ultags. TYPE_NUMBER- The items in the list are all numbered. This corresponds to HTML
oltags. TYPE_NAMED- The items in the list are named, as defined terms. This corresponds to HTML
dltags.
These are conceived of as ordered, so that the presence of TYPE_NUMBER will outrank TYPE_BULLET and TYPE_NAMED outranks both. It is not currently possible to mix them in the same list.
Reimplemented from Doxygen::POD::Item.
The documentation for this class was generated from the following file:
- POD/Item/Over/Over.pm
Generated on Mon Dec 27 2010 15:15:39 for DoxyFilt by
1.7.1 