NAME
OODoc::Text::Chapter - collects the information of one chapter
INHERITANCE
OODoc::Text::Chapter
is a OODoc::Text::Structure
is a OODoc::Text
is a OODoc::ObjectSYNOPSIS
DESCRIPTION
OVERLOADED
overload: '""' (stringification)
overload: '==' and '!='
overload: 'cmp' (string comparison)
METHODS
Initiation
$obj->emptyExtension(CONTAINER)
OODoc::Text::Chapter->new(OPTIONS)
Option Defined in Default
container OODoc::Text C<manual>
description OODoc::Text ''
level OODoc::Text::Structure 1
linenr OODoc::Text <required>
manual C<undef>
name OODoc::Text C<undef>
type OODoc::Text <required>. container OBJECT
. description STRING
. level INTEGER
. linenr INTEGER
. manual OBJECT
The manual in which this chapter is described.
. name STRING
. type STRING
Attributes
$obj->container([OBJECT])
$obj->description
$obj->level
$obj->name
$obj->niceName
$obj->type
Location
$obj->manual
$obj->path
$obj->unique
$obj->where
Collected
$obj->all(METHOD, PARAMETERS)
$obj->example(OBJECT)
$obj->examples
$obj->extends([OBJECT])
$obj->findDescriptionObject
$obj->openDescription
Subroutines
$obj->addSubroutine(OBJECTS)
$obj->setSubroutines(ARRAY)
$obj->subroutine(NAME)
$obj->subroutines
Commonly used functions
$obj->filenameToPackage(FILENAME)
OODoc::Text::Chapter->filenameToPackage(FILENAME)
$obj->mkdirhier(DIRECTORY)
OODoc::Text::Chapter->mkdirhier(DIRECTORY)
Manual Repository
$obj->addManual(MANUAL)
$obj->mainManual(NAME)
$obj->manuals
$obj->manualsForPackage(NAME)
$obj->packageNames
Sections
A chapters consists of a list of sections, which may contain subsections.
$obj->section(NAME|OBJECT)
With a NAME, the section within this chapter with that name is returned. With an OBJECT (which must be a OODoc::Text::Section), a new section is added to the end of the list.
$obj->sections([SECTIONS])
Returns a list of all sections in this chapter.
Collecting information
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().
REFERENCES
See the OODoc website at http://perl.overmeer.net/oodoc/ for more details.
COPYRIGHTS
Module version 0.04. Written by Mark Overmeer (mark@overmeer.net). See the ChangeLog for other contributors.
Copyright (c) 2003 by the author(s). All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.