=head1 NAME
OODoc::Text::Section - collects the text of one section within a chapter
=head1 INHERITANCE
OODoc::Text::Section
is a OODoc::Text::Structure
is a OODoc::Text
is a OODoc::Object
=head1 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
=head1 OVERLOADED
=over 4
=item overload: B<'""' (stringification)>
See L<OODoc::Text/"OVERLOADED">
=item overload: B<'==' and '!='>
See L<OODoc::Text/"OVERLOADED">
=item overload: B<'cmp' (string comparison)>
See L<OODoc::Text/"OVERLOADED">
=back
=head1 METHODS
=head2 Constructors
=over 4
=item $obj-E<gt>B<emptyExtension>(CONTAINER)
See L<OODoc::Text::Structure/"Constructors">
=item OODoc::Text::Section-E<gt>B<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'
=over 2
=item chapter => OBJECT
=item container => OBJECT
=item description => STRING
=item level => INTEGER
=item linenr => INTEGER
=item name => STRING
=item type => STRING
=back
=back
=head2 Inheritance knowledge
=over 4
=item $obj-E<gt>B<extends>([OBJECT])
See L<OODoc::Object/"Inheritance knowledge">
=back
=head2 Attributes
=over 4
=item $obj-E<gt>B<container>([OBJECT])
See L<OODoc::Text/"Attributes">
=item $obj-E<gt>B<description>
See L<OODoc::Text/"Attributes">
=item $obj-E<gt>B<level>
See L<OODoc::Text::Structure/"Attributes">
=item $obj-E<gt>B<name>
See L<OODoc::Text/"Attributes">
=item $obj-E<gt>B<niceName>
See L<OODoc::Text::Structure/"Attributes">
=item $obj-E<gt>B<type>
See L<OODoc::Text/"Attributes">
=back
=head2 Location
=over 4
=item $obj-E<gt>B<chapter>
Returns the chapter object for this section.
=item $obj-E<gt>B<findEntry>(NAME)
See L<OODoc::Text::Structure/"Location">
=item $obj-E<gt>B<manual>([NAME])
See L<OODoc::Text/"Location">
=item $obj-E<gt>B<path>
See L<OODoc::Text::Structure/"Location">
=item $obj-E<gt>B<unique>
See L<OODoc::Text/"Location">
=item $obj-E<gt>B<where>
See L<OODoc::Text/"Location">
=back
=head2 Collected
=over 4
=item $obj-E<gt>B<all>(METHOD, PARAMETERS)
See L<OODoc::Text::Structure/"Collected">
=item $obj-E<gt>B<example>(OBJECT)
See L<OODoc::Text/"Collected">
=item $obj-E<gt>B<examples>
See L<OODoc::Text/"Collected">
=item $obj-E<gt>B<findDescriptionObject>
See L<OODoc::Text/"Collected">
=item $obj-E<gt>B<isEmpty>
See L<OODoc::Text::Structure/"Collected">
=item $obj-E<gt>B<openDescription>
See L<OODoc::Text/"Collected">
=back
=head2 Subroutines
=over 4
=item $obj-E<gt>B<addSubroutine>(OBJECTS)
See L<OODoc::Text::Structure/"Subroutines">
=item $obj-E<gt>B<setSubroutines>(ARRAY)
See L<OODoc::Text::Structure/"Subroutines">
=item $obj-E<gt>B<subroutine>(NAME)
See L<OODoc::Text::Structure/"Subroutines">
=item $obj-E<gt>B<subroutines>
See L<OODoc::Text::Structure/"Subroutines">
=back
=head2 Subsections
=over 4
=item $obj-E<gt>B<subsection>(NAME|OBJECT)
With a NAME, the subsection within this section with that name is
returned. With an OBJECT (which must be a L<OODoc::Text::SubSection|OODoc::Text::SubSection>),
a new subsection is added to the end of the list.
=item $obj-E<gt>B<subsections>([SUBSECTIONS])
Returns a list of all subsections in this chapter.
=back
=head2 Commonly used functions
=over 4
=item $obj-E<gt>B<filenameToPackage>(FILENAME)
OODoc::Text::Section-E<gt>B<filenameToPackage>(FILENAME)
See L<OODoc::Object/"Commonly used functions">
=item $obj-E<gt>B<mkdirhier>(DIRECTORY)
OODoc::Text::Section-E<gt>B<mkdirhier>(DIRECTORY)
See L<OODoc::Object/"Commonly used functions">
=back
=head2 Manual Repository
=over 4
=item $obj-E<gt>B<addManual>(MANUAL)
See L<OODoc::Object/"Manual Repository">
=item $obj-E<gt>B<mainManual>(NAME)
See L<OODoc::Object/"Manual Repository">
=item $obj-E<gt>B<manuals>
See L<OODoc::Object/"Manual Repository">
=item $obj-E<gt>B<manualsForPackage>(NAME)
See L<OODoc::Object/"Manual Repository">
=item $obj-E<gt>B<packageNames>
See L<OODoc::Object/"Manual Repository">
=back
=head1 DIAGNOSTICS
=over 4
=item Error: manual definition requires manual object
A call to L<addManual()|OODoc::Object/"Manual Repository"> expects a new manual object (a L<OODoc::Manual|OODoc::Manual>),
however an incompatible thing was passed. Usually, intended was a call
to L<manualsForPackage()|OODoc::Object/"Manual Repository"> or L<mainManual()|OODoc::Object/"Manual Repository">.
=back
=head1 SEE ALSO
This module is part of OODoc distribution version 1.06,
built on January 26, 2011. Website: F<http://perl.overmeer.net/oodoc/>
=head1 LICENSE
Copyrights 2003-2011 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 F<http://www.perl.com/perl/misc/Artistic.html>