NAME
OODoc::Text::Section - collects the text of one section within a chapter
INHERITANCE
OODoc::Text::Section
is a OODoc::Text::Structure
is a OODoc::Text
is a OODoc::ObjectSYNOPSIS
my $chapter = $section->chapter;
my @subsect = $section->subsections;
my $index = $section->subsection('INDEX'); # returns subsection
my $index = OODoc::Text::SubSection->new(...);
$section->subsection($index); # set subsectionDESCRIPTION
METHODS
Subsections
$obj->subsection(NAME|OBJECT)
With a NAME, the subsection within this section with that name is returned. With an OBJECT (which must be a OODoc::Text::SubSection), a new subsection is added to the end of the list.
$obj->subsections([SUBSECTIONS])
Returns a list of all sections in this chapter.
Attributes
$obj->description
$obj->findDescriptionObject
$obj->openDescription
$obj->type
$obj->where
Container
$obj->chapter
Returns the chapter object for this section.
Collecting Information
$obj->allExamples
Returns a list of all example, which are OODoc::Text::Example objects, enclosed in the section and its subsections.
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::Section->new(OPTIONS)
Inheritance
$obj->extends([OBJECT])
Commonly used functions
$obj->filenameToPackage(FILENAME)
OODoc::Text::Section->filenameToPackage(FILENAME)
$obj->mergeObjects(OPTIONS)
$obj->mkdirhier(DIRECTORY)
OODoc::Text::Section->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.