NAME
OODoc::Text::SubSection - collects the text of one subsection within a section
INHERITANCE
OODoc::Text::SubSection
is an OODoc::Text::Structure
is an OODoc::Text
is an 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.
Extends "DESCRIPTION" in OODoc::Text::Structure.
OVERLOADED
Extends "OVERLOADED" in OODoc::Text::Structure.
- overload: '""' <$stringification>
-
Inherited, see "OVERLOADED" in OODoc::Text
- overload: '==' $and '!='
-
Inherited, see "OVERLOADED" in OODoc::Text
- overload: 'cmp' <$string $comparison>
-
Inherited, see "OVERLOADED" in OODoc::Text
METHODS
Extends "METHODS" in OODoc::Text::Structure.
Constructors
Extends "Constructors" in OODoc::Text::Structure.
- $obj->emptyExtension($container)
-
Inherited, see "Constructors" in OODoc::Text::Structure
- 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'
Inheritance knowledge
Extends "Inheritance knowledge" in OODoc::Text::Structure.
- $obj->extends( [$object] )
-
Inherited, see "Inheritance knowledge" in OODoc::Object
Attributes
Extends "Attributes" in OODoc::Text::Structure.
- $obj->container( [$object] )
-
Inherited, see "Attributes" in OODoc::Text
- $obj->description()
-
Inherited, see "Attributes" in OODoc::Text
- $obj->level()
-
Inherited, see "Attributes" in OODoc::Text::Structure
- $obj->name()
-
Inherited, see "Attributes" in OODoc::Text
- $obj->niceName()
-
Inherited, see "Attributes" in OODoc::Text::Structure
- $obj->type()
-
Inherited, see "Attributes" in OODoc::Text
Location
Extends "Location" in OODoc::Text::Structure.
- $obj->chapter()
-
Returns the chapter object for this subsection.
- $obj->findEntry($name)
-
Inherited, see "Location" in OODoc::Text::Structure
- $obj->manual( [$name] )
-
Inherited, see "Location" in OODoc::Text
- $obj->path()
-
Inherited, see "Location" in OODoc::Text::Structure
- $obj->section()
-
Returns the section object for this subsection.
- $obj->unique()
-
Inherited, see "Location" in OODoc::Text
- $obj->where()
-
Inherited, see "Location" in OODoc::Text
Collected
Extends "Collected" in OODoc::Text::Structure.
- $obj->all($method, $parameters)
-
Inherited, see "Collected" in OODoc::Text::Structure
- $obj->example($object)
-
Inherited, see "Collected" in OODoc::Text
- $obj->examples()
-
Inherited, see "Collected" in OODoc::Text
- $obj->findDescriptionObject()
-
Inherited, see "Collected" in OODoc::Text
- $obj->isEmpty()
-
Inherited, see "Collected" in OODoc::Text::Structure
- $obj->openDescription()
-
Inherited, see "Collected" in OODoc::Text
Subroutines
Extends "Subroutines" in OODoc::Text::Structure.
- $obj->addSubroutine($objects)
-
Inherited, see "Subroutines" in OODoc::Text::Structure
- $obj->setSubroutines(ARRAY)
-
Inherited, see "Subroutines" in OODoc::Text::Structure
- $obj->subroutine($name)
-
Inherited, see "Subroutines" in OODoc::Text::Structure
- $obj->subroutines()
-
Inherited, see "Subroutines" in OODoc::Text::Structure
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
Extends "Commonly used functions" in OODoc::Text::Structure.
- $obj->filenameToPackage($filename)
- OODoc::Text::SubSection->filenameToPackage($filename)
-
Inherited, see "Commonly used functions" in OODoc::Object
- $obj->mkdirhier($directory)
- OODoc::Text::SubSection->mkdirhier($directory)
-
Inherited, see "Commonly used functions" in OODoc::Object
Manual Repository
Extends "Manual Repository" in OODoc::Text::Structure.
- $obj->addManual($manual)
-
Inherited, see "Manual Repository" in OODoc::Object
- $obj->mainManual($name)
-
Inherited, see "Manual Repository" in OODoc::Object
- $obj->manuals()
-
Inherited, see "Manual Repository" in OODoc::Object
- $obj->manualsForPackage($name)
-
Inherited, see "Manual Repository" in OODoc::Object
- $obj->packageNames()
-
Inherited, see "Manual Repository" in OODoc::Object
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 2.02, built on December 08, 2021. Website: http://perl.overmeer.net/oodoc/
LICENSE
Copyrights 2003-2021 by [Mark Overmeer]. For other contributors see ChangeLog.
This program is free software; you can redistribute it and/or modify it under the Artistic license. See http://dev.perl.org/licenses/artistic.html