NAME
OODoc::Text::Structure - base class for chapters, sections and sub-sections
INHERITANCE
OODoc::Text::Structure
is a OODoc::Text
is a OODoc::Object
OODoc::Text::Structure is extended by
OODoc::Text::Chapter
OODoc::Text::Section
OODoc::Text::SubSection
SYNOPSIS
# Cannot be instantiated itself
DESCRIPTION
METHODS
Attributes
$obj->description
$obj->findDescriptionObject
$obj->openDescription
$obj->type
$obj->where
Container
$obj->all(METHOD, PARAMETERS)
Call the METHOD recursively on this object and all its sub-structures. For instance, when all
is called on a chapter, it first will call the METHOD on that chapter, than on all its sections and subsections. The PARAMETERS are passed with each call. The results of all calls is returned as list.
$obj->path
Represent the location of this chapter, section, or subsection as one string, separated by slashes.
Example:
print $subsect->path; # may print: METHODS/Container/Search
Subroutines
Each manual page structure element (chapter, section, and subsection) can contain a list of subroutine descriptions.
$obj->addSubroutine(OBJECT)
A subroutine (OODoc::Text::Subroutine object) is added to the chapter, section or subsection.
$obj->setSubroutines(OBJECTS)
Changes the list of subroutines for this text structure.
$obj->subroutine(NAME)
Returns the subroutine with the specific name.
$obj->subroutines
Returns the list of subroutines which are related to this text object.
Examples
$obj->example(OBJECT)
$obj->examples
Initiation
OODoc::Text::Structure->new(OPTIONS)
Inheritance
$obj->extends([OBJECT])
Commonly used functions
$obj->filenameToPackage(FILENAME)
OODoc::Text::Structure->filenameToPackage(FILENAME)
$obj->mergeObjects(OPTIONS)
$obj->mkdirhier(DIRECTORY)
OODoc::Text::Structure->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.