NAME
OODoc::Text::Example - one example for the use of a subroutine
INHERITANCE
OODoc::Text::Example
is a OODoc::Text
is a OODoc::ObjectSYNOPSIS
DESCRIPTION
Each OODoc::Text element can have a list of examples, which are each captured in a separate object as described in this manual page.
METHODS
Attributes
$obj->description
$obj->findDescriptionObject
$obj->openDescription
$obj->type
$obj->where
Container
$obj->container
$obj->manual
Examples
$obj->example(OBJECT)
$obj->examples
Initiation
OODoc::Text::Example->new(OPTIONS)
Inheritance
$obj->extends([OBJECT])
Commonly used functions
$obj->filenameToPackage(FILENAME)
OODoc::Text::Example->filenameToPackage(FILENAME)
$obj->mergeObjects(OPTIONS)
$obj->mkdirhier(DIRECTORY)
OODoc::Text::Example->mkdirhier(DIRECTORY)
$obj->unique
Manual database
All manuals can be reached everywhere in the program: it is a global collection.
$obj->addManual(MANUAL)
$obj->mainManual(NAME)
$obj->manuals
$obj->manualsForPackage(NAME)
$obj->packageNames
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().
Warning: order conflict "$take" before "$insert" in $file line $number
The order of the objects in a sub-class shall be the same as that of the super class, otherwise the result of merging of the information received from both classes is undertermined.