Perl extension for generating Doxygen documentation. More...

Inheritance diagram for Doxygen::Perl::Filter:

Public Member Functions
	new (%flags)
	Constructor for Doxygen::Perl::Filter objects.
	parse ($text, $source)
	Parse a source file.
	parseClass ($text, $source)
	Parse a section of source text beginning with a package declaration and ending before the next package declaration (or end of file).
	parseFunc ($function, $text, $source)
	Parse a section of source text beginning with a subroutine declaration and ending before the next subroutine declaration (or end of file).
	parseFuncs ($text, $source)
	Parse text associated with file or class.
	parseHeader ($text, $source)
	Parse a section of source text containing no package declarations.
	parsePlain ($text, $source)
	Parse a section of source text containing no package or function declarations.
	parseAnc_s ($source, $ancestors)
	Parse a list of ancestors from `@ISA` or `use base`.
	EndBlock (\\$text)
	Peels a last block of comments from a referenced chunk of text.

Detailed Description

Perl extension for generating Doxygen documentation.

SYNOPSIS

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

ABSTRACT

The basic Perl script filter, or parser. Processes a Perl script or module looking for subroutines and class inheritance. Creates appropriate Doxygen::Item and subclass objects to represent the file, any package (class) defined within the file, functions or methods defined in the file, and other miscellaneous comments. Stores the data on itself (single use only) and generates Doxygen-parseable output as required.

DESCRIPTION

Some comments are ignored by POD but can be used to push data straight through to Doxygen, so use Doxygen markup symbology. The comments are recognized by the comment pattern registered with the Doxygen::Source package, defaulting to the constant COMMENT defined in this module.

Octothorpe bars:

  ##################################################################

Must have at least 64 octothorpes (not settable at this time). Octothorpe bars may begin with any of the comment sequences, in which case the total must contain no spaces and be at least 64 characters long.

Octothorpe bars are immune to Doxygen pass-through. If you want to pass one through, make it with a comment trigraph (as above) followed by a space followed by whatever you want to pass through.

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'

Note:: This tests comments for files; This tests comments for classes

Author:: Marc M. Adkins, mailTo:Perl@Doorways.org

Definition at line 78 of file Filter.pm.

Member Function Documentation

Doxygen::Perl::Filter::EndBlock ( \\$ text )

Peels a last block of comments from a referenced chunk of text.

Defined essentially as one or more octothorpe separator bars followed by nothing but 'special' DoxyFilt comment lines (or blank lines) to the end of the text block:

  #########################################################
  #########################################################
  #
  #   Some comment text...
  #
  =EOT=

Remove the text block if it is found, otherwise undef.

Doxygen::Perl::Filter::new ( % flags )

Constructor for Doxygen::Perl::Filter objects.

Parameters:

%flags

flags to become object's fields

Reimplemented from Doxygen::Filter.

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

Parse a source file.

Attach results (Doxygen::Item objects) to Doxygen::Source object.

Parameters:

	$text	reference to text of entire file
	$source	source object for parse, contains persistent data for parse

Reimplemented from Doxygen::Filter.

Doxygen::Perl::Filter::parseAnc_s	(	$	source,
		$	ancestors
	)

Parse a list of ancestors from @ISA or use base.

Doxygen::Perl::Filter::parseClass	(	$	text,
		$	source
	)

Parse a section of source text beginning with a package declaration and ending before the next package declaration (or end of file).

Doxygen::Perl::Filter::parseFunc	(	$	function,
		$	text,
		$	source
	)

Parse a section of source text beginning with a subroutine declaration and ending before the next subroutine declaration (or end of file).

Doxygen::Perl::Filter::parseFuncs	(	$	text,
		$	source
	)

Parse text associated with file or class.

Break out functions and act appropriately.

Doxygen::Perl::Filter::parseHeader	(	$	text,
		$	source
	)

Parse a section of source text containing no package declarations.

Doxygen::Perl::Filter::parsePlain	(	$	text,
		$	source
	)

Parse a section of source text containing no package or function declarations.

### @internal

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

Perl/Filter/Filter.pm

DoxyFilt: Doxygen::Perl::Filter Class Reference

Doxygen::Perl::Filter Class Reference