OODoc::Format::Pod3 - Produce POD pages using OODoc::Template
OODoc::Format::Pod3 is a OODoc::Format::Pod is a OODoc::Format is a OODoc::Object
my $doc = OODoc->new(...); $doc->create ( 'pod3' # or 'OODoc::Format::Pod3' , format_options => [show_examples => 'NO'] );
Create manual pages in the POD syntax, using the OODoc::Template template system.
See "METHODS" in OODoc::Format
See "Inheritance knowledge" in OODoc::Object
See "Attributes" in OODoc::Format
See "Page generation" in OODoc::Format
See "Page generation" in OODoc::Format::Pod
-Option --Defined in --Default append OODoc::Format::Pod '' format_options OODoc::Format [] manual OODoc::Format <required> project OODoc::Format <required> template <in code>
The default template is included in the DATA segment of OODoc::Format::Pod3. You may start your own template by copying it to a file.
OODoc::Format::Pod3->filenameToPackage(FILENAME)
See "Commonly used functions" in OODoc::Object
OODoc::Format::Pod3->mkdirhier(DIRECTORY)
See "Manual Repository" in OODoc::Object
A formatter was created without a name specified for the project at hand. This should be passed with new(project).
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().
The formatter has to know where the output can be written. This directory must be provided via new(workdir), but was not specified.
This module is part of OODoc distribution version 1.06, built on January 26, 2011. Website: http://perl.overmeer.net/oodoc/
Copyrights 2003-2011 by Mark Overmeer. For other contributors see ChangeLog.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See http://www.perl.com/perl/misc/Artistic.html
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.