Index

NAME
INHERITANCE
SYNOPSIS
DESCRIPTION
OVERLOADED
METHODS
DIAGNOSTICS
- Error: manual definition requires manual object
SEE ALSO
LICENSE

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.

OVERLOADED

overload: '""' (stringification): See "OVERLOADED" in OODoc::Text
overload: '==' and '!=': See "OVERLOADED" in OODoc::Text
overload: 'cmp' (string comparison): See "OVERLOADED" in OODoc::Text

METHODS

Constructors

$obj->emptyExtension(CONTAINER)

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'

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]): See "Inheritance knowledge" in OODoc::Object

Attributes

$obj->container([OBJECT]): See "Attributes" in OODoc::Text
$obj->description: See "Attributes" in OODoc::Text
$obj->level: See "Attributes" in OODoc::Text::Structure
$obj->name: See "Attributes" in OODoc::Text
$obj->niceName: See "Attributes" in OODoc::Text::Structure
$obj->type: See "Attributes" in OODoc::Text

Location

$obj->chapter: Returns the chapter object for this subsection.
$obj->findEntry(NAME): See "Location" in OODoc::Text::Structure
$obj->manual([NAME]): See "Location" in OODoc::Text
$obj->path: See "Location" in OODoc::Text::Structure
$obj->section: Returns the section object for this subsection.
$obj->unique: See "Location" in OODoc::Text
$obj->where: See "Location" in OODoc::Text

Collected

$obj->all(METHOD, PARAMETERS): See "Collected" in OODoc::Text::Structure
$obj->example(OBJECT): See "Collected" in OODoc::Text
$obj->examples: See "Collected" in OODoc::Text
$obj->findDescriptionObject: See "Collected" in OODoc::Text
$obj->isEmpty: See "Collected" in OODoc::Text::Structure
$obj->openDescription: See "Collected" in OODoc::Text

Subroutines

$obj->addSubroutine(OBJECTS): See "Subroutines" in OODoc::Text::Structure
$obj->setSubroutines(ARRAY): See "Subroutines" in OODoc::Text::Structure
$obj->subroutine(NAME): See "Subroutines" in OODoc::Text::Structure
$obj->subroutines: 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

$obj->filenameToPackage(FILENAME)

OODoc::Text::SubSection->filenameToPackage(FILENAME)

See "Commonly used functions" in OODoc::Object

$obj->mkdirhier(DIRECTORY)

OODoc::Text::SubSection->mkdirhier(DIRECTORY)