OODoc::Parser - base class for all OODoc parsers.
OODoc::Parser is a OODoc::Object OODoc::Parser is extended by OODoc::Parser::Markov
# Never instantiated directly.
OODoc::Parser->new(OPTIONS)
See "Constructors" in OODoc::Object
$obj->extends([OBJECT])
See "Inheritance knowledge" in OODoc::Object
$obj->parse(OPTIONS)
Parse the specified input file into a code file and an object tree which describes the pod. Returned is a list of package objects which contain the docs found in this file.
Option Defined in Default input <required> output <black hole>
. input FILENAME
The name of the input file.
. output FILENAME
Where to write the produced code to. If no filename is specified, the platform dependend black hole is used (/dev/null on UNIX).
After the manuals have been parsed into objects, the information can be formatted in various ways, for instance into POD and HTML. However, the parsing is not yet complete: the structure has been decomposed with parse(), but the text blocks not yet. This is because the transformations which are needed are context dependent. For each text section cleanup() is called for the final touch.
$obj->cleanup(FORMATTER, MANUAL, STRING)
$obj->filenameToPackage(FILENAME)
OODoc::Parser->filenameToPackage(FILENAME)
See "Commonly used functions" in OODoc::Object
$obj->mkdirhier(DIRECTORY)
OODoc::Parser->mkdirhier(DIRECTORY)
$obj->addManual(MANUAL)
See "Manual Repository" in OODoc::Object
$obj->mainManual(NAME)
$obj->manual(NAME)
$obj->manuals
$obj->manualsForPackage(NAME)
$obj->packageNames
Error: The formatter type $class is not known for cleanup
Text blocks have to get the finishing touch in the final formatting phase. The parser has to fix the text block segments to create a formatter dependent output. Only a few formatters are predefined.
Warning: Unknown option $name
You have used the option with $name, which is not defined with the instantiation (the new method) of this object.
new
Warning: Unknown options @names
You have used more than one option which is not defined to instantiate the object.
Error: manual definition requires manual object
A call to addManual() expects a new manual object (a OODoc::Manual), however an incompatible thing was passed. Usually, intended was a call to manualsForPackage() or mainManual().
See the OODoc website at http://perl.overmeer.net/oodoc/ for more details.
Module version 0.90. Written by Mark Overmeer (mark@overmeer.net). See the ChangeLog for other contributors.
Copyright (c) 2003 by the author(s). All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
To install OODoc, copy and paste the appropriate command in to your terminal.
cpanm
cpanm OODoc
CPAN shell
perl -MCPAN -e shell install OODoc
For more information on module installation, please visit the detailed CPAN module installation guide.