Perl extension for generating Doxygen documentation. More...

Inheritance diagram for Doxygen::POD::Filter:

Public Member Functions
	CleanText (\\$text)
	Remove all POD from the text referenced.
	parse ($text, $source)
	Parse a source file.
	massage ($source)
	Massage items in file after parsing and before generating.
	flags ($name)
	Return reference to flags hash for filter.

Detailed Description

Perl extension for generating Doxygen documentation.

SYNOPSIS

  my  $filter = new Doxygen::POD::Filter($path);

ABSTRACT

The basic POD filter, or parser. Processes a file of data looking for POD statements. Stores the data on itself (single use only) and generates Doxygen-parseable output as required.

DESCRIPTION

COPYRIGHT AND LICENSE

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::POD::Filter::CleanText ( \\$ text )

Remove all POD from the text referenced.

Removes the number of blocks removed.

Doxygen::POD::Filter::flags ( $ name )

Return reference to flags hash for filter.

These are default values.

Doxygen::POD::Filter::massage ( $ source )

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 overload of massage is used to connect POD items on this object to applicable Doxygen items on the source object, thereby enriching the latter.

Basically it looks for items named the same as functions that have been defined during the parse. If a match is found, the comment lines from the item are copied to the comment lines on the function and the item is changed to show a link to the function itself.

@note

This code was rewritten to use the names of functions as the search space and match items. This way if there are no functions, because the source is a POD file and has no actual code in it, the search will end quickly and not result in accidental matchups.

We originally tried to move much of this method to Doxygen::Perl::Filter, but it just did not know where the POD was, and rightfully so. Whereas from here the functions, which are of class Doxygen::Item::Function and thus neither POD-specific nor Perl-specific, are easily accessible.

Todo:: when copying arguments from item to function, compare them and generate warnings on mismatch

Doxygen::POD::Filter::parse	(	$	text,
		$	source
	)

Parse a source file.

Attach results (Doxygen::Item objects) to Doxygen::Source object. @note This is a line-by-line state machine. Works OK just on the POD, since now the Perl parsing has been removed to another file. Was really complicated before when they were combined into one parser.

Reimplemented from Doxygen::Filter.

The documentation for this class was generated from the following file:

POD/Filter/Filter.pm

DoxyFilt: Doxygen::POD::Filter Class Reference

Doxygen::POD::Filter Class Reference