OODoc::Text::Structure - set of paragraphs with examples and subroutines
OODoc::Text::Structure is a OODoc::Text is a OODoc::Object OODoc::Text::Structure is extended by OODoc::Text::Chapter OODoc::Text::Section OODoc::Text::SubSection OODoc::Text::SubSubSection
# Cannot be instantiated itself
The OODoc::Text::Structure class is used as base class for the OODoc::Text::Chapter, OODoc::Text::Section, and OODoc::Text::SubSection classes. Each of these classes group some paragraphs of text, probably some examples and some subroutines: they provide a structure to the document.
Extends "DESCRIPTION" in OODoc::Text.
Extends "OVERLOADED" in OODoc::Text.
Inherited, see "OVERLOADED" in OODoc::Text
Extends "METHODS" in OODoc::Text.
Extends "Constructors" in OODoc::Text.
Create an empty copy of a structured text element, which is used at a higher level of inheritance to collect related subroutines and such.
-Option --Defined in --Default container OODoc::Text <required> description OODoc::Text '' level <required> linenr OODoc::Text <required> name OODoc::Text undef type OODoc::Text <required>
Header level of the text structure. A chapter will be 1, section 2, and subsection 3.
Extends "Inheritance knowledge" in OODoc::Text.
Inherited, see "Inheritance knowledge" in OODoc::Object
Extends "Attributes" in OODoc::Text.
Inherited, see "Attributes" in OODoc::Text
Returns the level of the text structure. Like in pod and html, a chapter will be 1, section 2, and subsection 3.
Returns the name of this chapter, section or sub-section beautified to normal caps. If the name does not contain lower-case characters, then the whole string is lower-cased, and then the first upper-cased.
Extends "Location" in OODoc::Text.
Find the chapter, section or subsection with this $name. The object found is returned.
Inherited, see "Location" in OODoc::Text
Represent the location of this chapter, section, or subsection as one string, separated by slashes.
example:
print $subsect->path; # may print: METHODS/Container/Search
Extends "Collected" in OODoc::Text.
Call the $method recursively on this object and all its sub-structures. For instance, when all is called on a chapter, it first will call the $method on that chapter, than on all its sections and subsections. The $parameters are passed with each call. The results of all calls is returned as list.
all
Inherited, see "Collected" in OODoc::Text
Return true if this text structure is only a place holder for something found in a super class. Structured elements are created with emptyExtension() on each sub-class pass the idea of order and to collect subroutines to be listed. However, in some cases, nothing is to be listed after all, and in that case, this method returns true.
true
unless($chapter->isEmpty) ...
Each manual page structure element (chapter, section, and subsection) can contain a list of subroutine descriptions.
A subroutine (OODoc::Text::Subroutine object) is added to the chapter, section, or subsection.
Sets the subroutines which are related to this text structure, replacing the preivous set. This is used when the manual pages are expanded into each-other to simplify working with the inheritance relations.
Returns the subroutine with the specific name.
Returns the list of subroutines which are related to this text object.
Extends "Commonly used functions" in OODoc::Text.
Inherited, see "Commonly used functions" in OODoc::Object
Extends "Manual Repository" in OODoc::Text.
Inherited, see "Manual Repository" in OODoc::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().
This module is part of OODoc distribution version 2.01, built on November 11, 2015. Website: http://perl.overmeer.net/oodoc/
Copyrights 2003-2015 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
To install OODoc, copy and paste the appropriate command in to your terminal.
cpanm
cpanm OODoc
CPAN shell
perl -MCPAN -e shell install OODoc
For more information on module installation, please visit the detailed CPAN module installation guide.