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::ObjectSYNOPSIS
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.
OVERLOADED
overload: '""' (stringification)
overload: '==' and '!='
overload: 'cmp' (string comparison)
METHODS
Constructors
$obj->emptyExtension(CONTAINER)
OODoc::Text::SubSection->new(OPTIONS)
Option --Defined in --Default
container OODoc::Text new(section)
description OODoc::Text ''
level OODoc::Text::Structure 3
linenr OODoc::Text <required>
name OODoc::Text undef
section <required>
type OODoc::Text 'Subsection'. container => OBJECT
. description => STRING
. level => INTEGER
. linenr => INTEGER
. name => STRING
. section => OBJECT
The section in which this sub-section lives.
. type => STRING
Inheritance knowledge
$obj->extends([OBJECT])
Attributes
$obj->container([OBJECT])
$obj->description
$obj->level
$obj->name
$obj->niceName
$obj->type
Location
$obj->chapter
Returns the chapter object for this subsection.
$obj->findEntry(NAME)
$obj->manual([NAME])
$obj->path
$obj->section
Returns the section object for this subsection.
$obj->unique
$obj->where
Collected
$obj->all(METHOD, PARAMETERS)
$obj->example(OBJECT)
$obj->examples
$obj->findDescriptionObject
$obj->isEmpty
$obj->openDescription
Subroutines
$obj->addSubroutine(OBJECTS)
$obj->setSubroutines(ARRAY)
$obj->subroutine(NAME)
$obj->subroutines
Subsubsections
$obj->subsubsection(NAME|OBJECT)
With a NAME, the subsubsection within this subsection with that name is returned. With an OBJECT (which must be a OODoc::Text::SubSubSection), a new subsubsection is added to the end of the list.
$obj->subsubsections([SUBSUBSECTIONS])
Returns a list of all subsubsections in this chapter.
Commonly used functions
$obj->filenameToPackage(FILENAME)
OODoc::Text::SubSection->filenameToPackage(FILENAME)
$obj->mkdirhier(DIRECTORY)
OODoc::Text::SubSection->mkdirhier(DIRECTORY)
Manual Repository
$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().
SEE ALSO
This module is part of OODoc distribution version 1.03, built on March 14, 2008. Website: http://perl.overmeer.net/oodoc/
LICENSE
Copyrights 2003-2008 by Mark Overmeer. For other contributors see ChangeLog.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See http://www.perl.com/perl/misc/Artistic.html