SBIA::BASIS::DoxyGen::Filter Class Reference

Inheritance diagram for SBIA::BASIS::DoxyGen::Filter:

List of all members.

Public Object Methods
object	new (scalar outfh)
virtual void	filter (scalar infh)=0
void	start (scalar command)
void	end ()
void	push (scalar section)
void	pop ()
void	print (list args)
void	more (list args)
void	flush ()
Protected Object Methods
protected string	protection (scalar sig)

---

Detailed Description

Filter from non-C++ syntax API docs to Doxygen-compatible syntax. This class is meant to be used as a filter for the Doxygen documentation tool.

Definition at line 12 of file Filter.pm.

---

Member Function Documentation

void SBIA::BASIS::DoxyGen::Filter::end

(

)

end a doc comment. Outputs the end of a javadoc comment.

void SBIA::BASIS::DoxyGen::Filter::filter

(

scalar

infh

)

[pure virtual]

do the filtering.

Parameters:

infh	input filehandle, normally STDIN

Implemented in SBIA::BASIS::DoxyGen::PerlFilter.

void SBIA::BASIS::DoxyGen::Filter::flush

(

)

Flush the saved sections. Should be called at the end of a class.

See also:

push(), print()

void SBIA::BASIS::DoxyGen::Filter::more

(

list

args

)

process the follow-up lines after the initial apidoc line.

Parameters:

args	the lines to be processed

object SBIA::BASIS::DoxyGen::Filter::new

(

scalar

outfh

)

create a filter object.

Parameters:

outfh

optional output filehandle; defaults to STDOUT

Returns:

filter object

void SBIA::BASIS::DoxyGen::Filter::pop

(

)

End a diversion to a section.

See also:

push(), flush()

void SBIA::BASIS::DoxyGen::Filter::print

(

list

args

)

print a string to the output handle. If a diversion to a specific section is in effect: saves the text under that section.

Parameters:

args	the strings to be printed

See also:

push(), flush()

protected string SBIA::BASIS::DoxyGen::Filter::protection

(

scalar

sig

)

Return the protection of a method/function signature.

Parameters:

sig	the method signature

Returns:

Either "Public" or "Private".

void SBIA::BASIS::DoxyGen::Filter::push

(

scalar

section

)

Start a diversion to a section.

Parameters:

section

The name of the section to divert all output to.

See also:

pop(), print(), flush()

void SBIA::BASIS::DoxyGen::Filter::start

(

scalar

command

)

start a doc comment. Outputs the start of a javadoc comment.

Parameters:

command

the javadoc command

---

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

• Filter.pm