Embperl::Syntax::POD(3pm) - phpMan

Syntax::POD(3pm)               User Contributed Perl Documentation               Syntax::POD(3pm)



NAME
       Embperl::Syntax::POD

SYNOPSIS
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
       Documenation 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 dev.de)

See Also
       Embperl::Syntax



perl v5.10.0                                2005-12-09                           Syntax::POD(3pm)

Generated by $Id: phpMan.php,v 4.49 2006/02/26 13:18:18 chedong Exp $ Author: Che Dong
On Apache
Under GNU General Public License
2012-05-23 16:52 @38.107.179.239 Crawled by CCBot/1.0 (+http://www.commoncrawl.org/bot.html)