The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
OODoc-0.01
River stage zero No dependents
/ OODoc::Format::Pod

NAME

OODoc::Format::Pod - Produce POD pages from the doc tree

INHERITANCE

 OODoc::Format::Pod
   is a OODoc::Format
   is a OODoc::Object

SYNOPSIS

Complex:

 use OODoc::Format::Pod;
 my $pod = OODoc::Format::Pod->new;
 $pod->createPackageManual(manuals => \@mans, ...);

Simple:

 my $doc = OODoc->new(...);
 $doc->createManual('pod');

DESCRIPTION

Create manual pages in the POD syntax. POD is the standard document description syntax for Perl. POD can be translated to many different operating system specific manual systems, like the Unix man system.

METHODS

$obj->chapterInheritance(OPTIONS)

     Option  Defined in       Default   
 manual                   <required>
 output                   <required>

    . manual OBJECT

    . output IO::File

$obj->createPackageManual(OPTIONS)

     Option    Defined in       Default   
 manifest                   C<undef>  
 manuals                    []        
 verbose                    0         
 workdir                    <required>

    . manifest FILENAME

    . manuals ARRAY-OF-MANUALS

    . verbose INTEGER

    . workdir DIRECTORY

$obj->link(MANUAL, OBJECT, [TEXT])

    Create the text for a link which refers to the OBJECT. The link will be shown somewhere in the MANUAL. The TEXT will be displayed is stead of the link path, when specified.

$obj->showChapterIndex(FILE, CHAPTER, INDENT)

$obj->showChapters(OPTIONS)

     Option           Defined in       Default   
 display_options                   <see text>
 manual                            <required>
 output                            <required>

    . display_options HASH

      The display options are used to tell the formatter exactly what the output must be. The output is extremely configurable, by extension of the methods and by passing all kinds of options.

    . manual MANUAL

    . output FILE

$obj->writeTable

     Option  Defined in       Default   
 ARRAY                    <required>
 header                   <required>
 output                   <required>
 widths                   C<undef>

    . ARRAY -OF-ARRAYS

      An array of arrays, each describing a row for the output. The first row is the header.

    . header ARRAY

    . output FILE

    . widths ARRAY

Initiation

OODoc::Format::Pod->new(OPTIONS)

Inheritance

$obj->extends([OBJECT])

Commonly used functions

$obj->filenameToPackage(FILENAME)

OODoc::Format::Pod->filenameToPackage(FILENAME)

$obj->mergeObjects(OPTIONS)

$obj->mkdirhier(DIRECTORY)

OODoc::Format::Pod->mkdirhier(DIRECTORY)

$obj->unique

Manual database

All manuals can be reached everywhere in the program: it is a global collection.

$obj->addManual(MANUAL)

$obj->mainManual(NAME)

$obj->manuals

$obj->manualsForPackage(NAME)

$obj->packageNames

DIAGNOSTICS

Error: cannot write pod manual at $manfile: $!

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().

Error: no directory to put pod manual for $name in

Error: no package name for pod production

Warning: order conflict "$take" before "$insert" in $file line $number

The order of the objects in a sub-class shall be the same as that of the super class, otherwise the result of merging of the information received from both classes is undertermined.