The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
OODoc-1.04
River stage zero No dependents
1 ++
/ OODoc::Text::Section

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

DESCRIPTION

OVERLOADED

overload: '""' (stringification)

overload: '==' and '!='

overload: 'cmp' (string comparison)

METHODS

Constructors

$obj->emptyExtension(CONTAINER)

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])

Attributes

$obj->container([OBJECT])

$obj->description

$obj->level

$obj->name

$obj->niceName

$obj->type

Location

$obj->chapter

    Returns the chapter object for this section.

$obj->findEntry(NAME)

$obj->manual([NAME])

$obj->path

$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

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)

$obj->mkdirhier(DIRECTORY)

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

Manual Repository

$obj->addManual(MANUAL)

$obj->mainManual(NAME)

$obj->manuals

$obj->manualsForPackage(NAME)

$obj->packageNames

DIAGNOSTICS

Error: manual definition requires manual object

SEE ALSO

This module is part of OODoc distribution version 1.04, built on June 12, 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