Perl extension for generating Doxygen documentation. More...

Inheritance diagram for Doxygen::Item:

Public Member Functions
	new (%fields)
	Generic constructor for Doxygen::Item interprets all arguments as a hash object and blesses a reference thereto, making it easy to set initial field values.
	massage ($source)
	Item-specific massage sequences.
	generate (%flags)
	Generates output understandable by doxygen to standard output.
	genComment (%flags)
	Generates comment lines for the item.
	genThing ($thing,%flags)
	Generate a thing, which may be an object, an array reference, or a string.
	image ()
	Return image for item.
	itemSet ($which, $entity, $name)
	Set a named item of the specified type (`$which`).
	item ($which, $name)
	Return a named item of the specified type (`$which`).
	items ($which)
	Returns all named items of a specified type.
	text ($which)
	Returns array reference of array representing named text block.
	textAppend ($which,@@stuff)
	Appends stuff to the named text block.
	textPop ($which)
	Pops the last thing appended to the named text block.
	textClear ($which,@@stuff)
	Clears everything from the specified (`$which`) text block, leaving it empty.
	textString ($which)
	Returns text string with flattened (stringified) named text block.
	textThing ($which)
	Returns the text string for an item of unknown provenance.

Detailed Description

Perl extension for generating Doxygen documentation.

SYNOPSIS

Inherited by subclass:

  use base qw(Doxygen::Filter);

ABSTRACT

Provides a root class for a source object 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++.

A Doxygen::Item is an object that will be recognized by Doxygen when rendered as a combination of C/C++ source code and Doxygen-enabled comments. Known subclasses of Doxygen::Item include Doxygen::Item::Class, Doxygen::Item::Class and Doxygen::Item::Function.

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 53 of file Item.pm.

Member Function Documentation

Doxygen::Item::genComment ( % flags )

Generates comment lines for the item.

Doxygen::Item::generate ( % flags )

Generates output understandable by doxygen to standard output.

Reimplemented in Doxygen::Item::Class, Doxygen::Item::Function, Doxygen::POD::Item::Code, Doxygen::POD::Item::Format, Doxygen::POD::Item::Head, Doxygen::POD::Item, Doxygen::POD::Item::Over, and Doxygen::Source.

Doxygen::Item::genThing	(	$	thing,
		%	flags
	)

Generate a thing, which may be an object, an array reference, or a string.

When the thing is an object of type Doxygen::Item it is generated using the generate method.

Recursive.

Doxygen::Item::image ( )

Return image for item.

Doxygen::Item::item	(	$	which,
		$	name
	)

Return a named item of the specified type ($which).

Doxygen::Item::items ( $ which )

Returns all named items of a specified type.

Doxygen::Item::itemSet	(	$	which,
		$	entity,
		$	name
	)

Set a named item of the specified type ($which).

Doxygen::Item::massage ( $ source )

Item-specific massage sequences.

Reimplemented in Doxygen::Item::Class, Doxygen::Item::File, Doxygen::Item::Function, Doxygen::POD::Item::Code, and Doxygen::POD::Item.

Doxygen::Item::new ( % fields )

Generic constructor for Doxygen::Item interprets all arguments as a hash object and blesses a reference thereto, making it easy to set initial field values.

Reimplemented in Doxygen::Source.

Doxygen::Item::text ( $ which )

Returns array reference of array representing named text block.

Text blocks might include brief, comment, text. If no text block name ($which) is specified, the default 'text' block is used.

Doxygen::Item::textAppend	(	$	which,
		@@	stuff
	)

Appends stuff to the named text block.

If no text block name ($which) is specified (in which case undef must be used as a placeholder), the default 'text' block is used.

Doxygen::Item::textClear	(	$	which,
		@@	stuff
	)

Clears everything from the specified ($which) text block, leaving it empty.

Text blocks might include brief, comment, text. If no text block name ($which) is specified (in which case undef must be used as a placeholder), the default 'text' block is used.

Doxygen::Item::textPop ( $ which )

Pops the last thing appended to the named text block.

If no text block name ($which) is specified the default 'text' block is used.

The opposite of textAppend().

Doxygen::Item::textString ( $ which )

Returns text string with flattened (stringified) named text block.

Text blocks might include brief, comment, text. If no text block name ($which) is specified, the default 'text' block is used.

Doxygen::Item::textThing ( $ which )

Returns the text string for an item of unknown provenance.

Internal use.

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

Item/Item.pm

DoxyFilt: Doxygen::Item Class Reference

Doxygen::Item Class Reference