NAME¶
Embperl::Syntax::POD - convert POD to XML on-the-fly
DESCRIPTION¶
Class derived from Embperl::Syntax to convert Perl Plain Old Documentation (POD)
files on the fly into XML.
Used for generating the Embperl online documentation from the
Embperl POD files. See to eg directory in the distribution for an example
how to use it.
TODO¶
Documentation of the resulting XML format still has to be written...
Methods¶
Embperl::Syntax::POD defines the following methods:
Embperl::Syntax::POD -> new / $self -> new¶
Create a new syntax class. This method should only be called inside a
constructor of a derived class.
AddPODCmd ($cmdname, $procinfo)¶
Add a new POD command with name $cmdname and use
processor info from $procinfo. See
Embperl::Syntax for a definition of procinfo.
AddPODCmdStartEnd ($cmdname, $endname, $procinfo)¶
Add a new POD command with name $cmdname and use
processor info from $procinfo. Addtionaly specify that
a matching $endname POD command must be found to end
the block, that is started by this POD command. See Embperl::Syntax for
a definition of procinfo.
Author¶
G. Richter (richter at embperl dot org)
See Also¶
Embperl::Syntax
