NAME
OODoc::Text::Option - one option for one subroutine
INHERITANCE
OODoc::Text::Option
is a OODoc::Text
is a OODoc::ObjectSYNOPSIS
DESCRIPTION
Each OODoc::Text::Subroutine can have a list of options, which are each captured in a separate object as described in this manual page.
METHODS
$obj->parameters
Returns the short, informal description of the valid parameters for this option.
$obj->subroutine
Returns the subroutine object for this option.
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::Option->new(OPTIONS)
Inheritance
$obj->extends([OBJECT])
Commonly used functions
$obj->filenameToPackage(FILENAME)
OODoc::Text::Option->filenameToPackage(FILENAME)
$obj->mergeObjects(OPTIONS)
$obj->mkdirhier(DIRECTORY)
OODoc::Text::Option->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.
REFERENCES
See the OODoc website at $website for more details.
COPYRIGHTS
Module version $version. Written by Mark Overmeer (mark@overmeer.net). See the ChangeLog for other contributors.
Copyright (c) 2001-2002 by the authors. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.