NAME
OODoc::Text::Chapter - collects the information of one chapter
INHERITANCE
OODoc::Text::Chapter
is a OODoc::Text::Structure
is a OODoc::Text
is a OODoc::ObjectSYNOPSIS
DESCRIPTION
METHODS
Sections
A chapters consists of a list of sections, which may contain subsections.
$obj->section(NAME|OBJECT)
With a NAME, the section within this chapter with that name is returned. With an OBJECT (which must be a OODoc::Text::Section), a new section is added to the end of the list.
$obj->sections([SECTIONS])
Returns a list of all sections in this chapter.
Collecting information
Attributes
$obj->description
$obj->findDescriptionObject
$obj->openDescription
$obj->type
$obj->where
Container
$obj->all(METHOD, PARAMETERS)
$obj->path
Subroutines
Each manual page structure element (chapter, section, and subsection) can contain a list of subroutine descriptions.
$obj->addSubroutine(OBJECT)
$obj->setSubroutines(OBJECTS)
$obj->subroutine(NAME)
$obj->subroutines
Examples
$obj->example(OBJECT)
$obj->examples
Initiation
OODoc::Text::Chapter->new(OPTIONS)
Inheritance
$obj->extends([OBJECT])
Commonly used functions
$obj->filenameToPackage(FILENAME)
OODoc::Text::Chapter->filenameToPackage(FILENAME)
$obj->mergeObjects(OPTIONS)
$obj->mkdirhier(DIRECTORY)
OODoc::Text::Chapter->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: 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().
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.
REFERENCES
See the OODoc website at $website for more details.
COPYRIGHTS
Module version $version. Written by Mark Overmeer (mark@overmeer.net). See the ChangeLog for other contributors.
Copyright (c) 2001-2002 by the authors. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.