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::Object

SYNOPSIS

my $chapter = $section->chapter;
my @subsect = $section->subsections;

my $index   = $section->subsection('INDEX');

my $index   = OODoc::Text::SubSection->new(...);
$section->subsection($index);           # add subsection

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::Section->new(OPTIONS)

-Option     --Defined in            --Default
 chapter                              <required>
 container    OODoc::Text             new(chapter)
 description  OODoc::Text             ''
 level        OODoc::Text::Structure  2
 linenr       OODoc::Text             <required>
 name         OODoc::Text             undef
 type         OODoc::Text             'Section'

chapter => OBJECT

container => OBJECT

description => STRING

level => INTEGER

linenr => INTEGER

name => STRING

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 section.

$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->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

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 subsections in this chapter.

Commonly used functions

$obj->filenameToPackage(FILENAME)

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

See "Commonly used functions" in OODoc::Object

$obj->mkdirhier(DIRECTORY)

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

See "Commonly used functions" in OODoc::Object

Manual Repository

$obj->addManual(MANUAL)

See "Manual Repository" in OODoc::Object

$obj->mainManual(NAME)

See "Manual Repository" in OODoc::Object

$obj->manuals()

See "Manual Repository" in OODoc::Object

$obj->manualsForPackage(NAME)

See "Manual Repository" in OODoc::Object

$obj->packageNames()

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.00, built on January 11, 2013. Website: http://perl.overmeer.net/oodoc/

LICENSE

Copyrights 2003-2013 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

cpanm OODoc

perl -MCPAN -e shell
install OODoc