OODoc - object oriented production of code related documentation River stage zero No dependents

OODoc stands for "Object Oriented Documentation": to produce manual-pages in HTML or the usual man-page UNIX format, describing Perl programs. The OO part of the name refers to two things: this module simplifies writing documentation for Object Orien...

MARKOV/OODoc-2.01 - 11 Nov 2015 11:29:35 GMT

OODoc::Text - text component as found in a manual River stage zero No dependents

The parsers (implemented in the OODoc::Parser classes) scan the documentation as written down by the author of the module, and build a tree of these OODoc::Text objects from it. Then, any formatter (implemented by the OODoc::Format classes) can take ...

MARKOV/OODoc-2.01 - 11 Nov 2015 11:29:35 GMT

OODoc::Format - base class for all OODoc formatters River stage zero No dependents

A formater produces manual pages in some way or an other which contain (parts of) the module documentation. Each formatter class is based on this OODoc::Format class, which should not be instantiated directly. By far most users will never explicitly ...

MARKOV/OODoc-2.01 - 11 Nov 2015 11:29:35 GMT

OODoc::Manual - one manual about a package River stage zero No dependents

The "OODoc::Manual" object contains information of a singel manual page. More than one manual can be related to a single package. Extends "DESCRIPTION" in OODoc::Object....

MARKOV/OODoc-2.01 - 11 Nov 2015 11:29:35 GMT

OODoc::Object - base class for all OODoc classes. River stage zero No dependents

Any object used in the OODoc module is derived from this OODoc::Object class. This means that all functionality in this class is provided for all of the other classes....

MARKOV/OODoc-2.01 - 11 Nov 2015 11:29:35 GMT

OODoc::Parser - base class for all OODoc parsers. River stage zero No dependents

A parser is used to process files which contain POD or contain code: their filename extension is "pod", "pm", or "pl" (actually, this can be configured). Currently distributed parsers: * OODoc::Parser::Markov The Markov parser understands standard PO...

MARKOV/OODoc-2.01 - 11 Nov 2015 11:29:35 GMT

OODoc::Manifest - maintain the information inside a manifest file. River stage zero No dependents

Extends "DESCRIPTION" in OODoc::Object....

MARKOV/OODoc-2.01 - 11 Nov 2015 11:29:35 GMT

OODoc::Format::Pod - Produce POD pages from the doc tree River stage zero No dependents

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. Extends "DESCRIPTION" in OODoc::Format....

MARKOV/OODoc-2.01 - 11 Nov 2015 11:29:35 GMT

OODoc::Format::Pod3 - Produce POD pages using OODoc::Template River stage zero No dependents

Create manual pages in the POD syntax, using the OODoc::Template template system. Extends "DESCRIPTION" in OODoc::Format::Pod....

MARKOV/OODoc-2.01 - 11 Nov 2015 11:29:35 GMT

OODoc::Format::Pod2 - Produce POD pages from the doc tree with a template River stage zero No dependents

Create manual pages in the POD syntax, using the Template::Magic template system. It may be a bit simpler to configure the outcome using the template, than using OODoc::Format::Pod, however you first need to install Bundle::Template::Magic. Extends "...

MARKOV/OODoc-2.01 - 11 Nov 2015 11:29:35 GMT

OODoc::Text::Option - one option for one subroutine River stage zero No dependents

Each OODoc::Text::Subroutine can have a list of options, which are each captured in a separate object as described in this manual page. Extends "DESCRIPTION" in OODoc::Text....

MARKOV/OODoc-2.01 - 11 Nov 2015 11:29:35 GMT

OODoc::Format::Html - Produce HTML pages using OODoc::Template River stage zero No dependents

Create manual pages in the HTML syntax, using the OODoc::Template template system. Producing HTML is more complicated than producing POD, because one manual page may be spread over multiple output files. Extends "DESCRIPTION" in OODoc::Format....

MARKOV/OODoc-2.01 - 11 Nov 2015 11:29:35 GMT

OODoc::Text::Default - one default for an option in one subroutine River stage zero No dependents

Each OODoc::Text::Subroutine can have a list of options, which have default values which are each captured in a separate object as described in this manual page. Extends "DESCRIPTION" in OODoc::Text....

MARKOV/OODoc-2.01 - 11 Nov 2015 11:29:35 GMT

OODoc::Text::Example - one example for the use of a subroutine River stage zero No dependents

Each OODoc::Text element can have a list of examples, which are each captured in a separate object as described in this manual page. Extends "DESCRIPTION" in OODoc::Text....

MARKOV/OODoc-2.01 - 11 Nov 2015 11:29:35 GMT

OODoc::Text::Chapter - collects the information of one chapter River stage zero No dependents

Extends "DESCRIPTION" in OODoc::Text::Structure....

MARKOV/OODoc-2.01 - 11 Nov 2015 11:29:35 GMT

OODoc::Text::Section - collects the text of one section within a chapter River stage zero No dependents

Extends "DESCRIPTION" in OODoc::Text::Structure....

MARKOV/OODoc-2.01 - 11 Nov 2015 11:29:35 GMT

OODoc::Parser::Markov - Parser for the MARKOV syntax River stage zero No dependents

The Markov parser is named after the author, because the author likes to invite other people to write their own parser as well: every one has not only their own coding style, but also their own documentation wishes. The task for the parser is to stri...

MARKOV/OODoc-2.01 - 11 Nov 2015 11:29:35 GMT

OODoc::Text::Structure - set of paragraphs with examples and subroutines River stage zero No dependents

The OODoc::Text::Structure class is used as base class for the OODoc::Text::Chapter, OODoc::Text::Section, and OODoc::Text::SubSection classes. Each of these classes group some paragraphs of text, probably some examples and some subroutines: they pro...

MARKOV/OODoc-2.01 - 11 Nov 2015 11:29:35 GMT

OODoc::Text::SubSection - collects the text of one subsection within a section River stage zero No dependents

A subsection (or head3) is the third level of refining document hierarchies. A subsection must be a part of a section, which is part of a chapter. Extends "DESCRIPTION" in OODoc::Text::Structure....

MARKOV/OODoc-2.01 - 11 Nov 2015 11:29:35 GMT

OODoc::Text::Subroutine - collects information about one documented sub River stage zero No dependents

Perl has various things we can call "sub" (for "subroutine") one way or the other. This object tries to store all types of them: methods, funtion, ties, and overloads. Actually, these are the most important parts of the documentation. The share more ...

MARKOV/OODoc-2.01 - 11 Nov 2015 11:29:35 GMT

47 results (0.065 seconds)