NAME
OODoc::Text::SubSection - collects the text of one subsection within a section
INHERITANCE
OODoc::Text::SubSection
is a OODoc::Text::Structure
is a OODoc::Text
is a OODoc::Object
SYNOPSIS
my $section = $subsection->section;
my $chapter = $subsection->chapter;
DESCRIPTION
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.
METHODS
Attributes
$obj->description
$obj->findDescriptionObject
$obj->openDescription
$obj->type
$obj->where
Container
$obj->chapter
Returns the chapter object for this subsection.
$obj->section
Returns the section object for this subsection.
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::SubSection->new(OPTIONS)
Inheritance
$obj->extends([OBJECT])
Commonly used functions
$obj->filenameToPackage(FILENAME)
OODoc::Text::SubSection->filenameToPackage(FILENAME)
$obj->mergeObjects(OPTIONS)
$obj->mkdirhier(DIRECTORY)
OODoc::Text::SubSection->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.