Perl extension for generating Doxygen documentation. More...

Inheritance diagram for Doxygen::Item::Function:

Public Member Functions
	massage ($source)
	Item-specific massage sequences.
	generate (%flags)
	Generates output understandable by doxygen to standard output.
	argument ($arg, $comment)
	Sets the value of (commented associated with) a single function argument.
	argClear ($arg)
	Clears named argument so it does not exist anymore.
	arguments ($arguments)
	Sets arguments for item.
	image (%flags)
	Return 'image' of the function call.

Detailed Description

Perl extension for generating Doxygen documentation.

SYNOPSIS

  my  $cls = new Doxygen::Item::Function;

ABSTRACT

A Doxygen::Item::Function object represents C/C++ function/method from a source file processing by the Doxygen documentation system. These objects should be created by a specific source-language filter (subclass of Doxygen::Filter, named Doxygen::languageFilter) when processing a source file.

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 50 of file Function.pm.

Member Function Documentation

Doxygen::Item::Function::argClear ( $ arg )

Clears named argument so it does not exist anymore.

Returns previous value or argument name if argument existed. Does not do anything but return undef if argument did not exist.

Parameters:

$arg

Argument name to be cleared (removed)

Doxygen::Item::Function::argument	(	$	arg,
		$	comment
	)

Sets the value of (commented associated with) a single function argument.

Doxygen::Item::Function::arguments ( $ arguments )

Sets arguments for item.

Just creates basic arguments, does not add comments but does add option flags based on initial (removed) '?' in argument name.

Doxygen::Item::Function::generate ( % flags )

Generates output understandable by doxygen to standard output.

Reimplemented from Doxygen::Item.

Doxygen::Item::Function::image ( % flags )

Return 'image' of the function call.

Doxygen::Item::Function::massage ( $ source )

Item-specific massage sequences.

Reimplemented from Doxygen::Item.

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

Item/Function/Function.pm

DoxyFilt: Doxygen::Item::Function Class Reference

Doxygen::Item::Function Class Reference