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.
OVERLOADED
overload: '""' (stringification)
overload: '==' and '!='
overload: 'cmp' (string comparison)
METHODS
Constructors
OODoc::Text::Option->new(OPTIONS)
Option --Defined in --Default
container OODoc::Text new(subroutine)
description OODoc::Text ''
linenr OODoc::Text <required>
name OODoc::Text undef
parameters <required>
subroutine <required>
type OODoc::Text 'Option'. container => OBJECT
. description => STRING
. linenr => INTEGER
. name => STRING
. parameters => STRING
An informal short description of the valid values for this option.
. subroutine => OBJECT
The subroutine in which this option lives.
. type => STRING
Inheritance knowledge
$obj->extends([OBJECT])
Attributes
$obj->container([OBJECT])
$obj->description
$obj->name
$obj->parameters
Returns the short, informal description of the valid parameters for this option.
$obj->subroutine
Returns the subroutine object for this option.
$obj->type
Location
$obj->manual([NAME])
$obj->unique
$obj->where
Collected
$obj->example(OBJECT)
$obj->examples
$obj->findDescriptionObject
$obj->openDescription
Commonly used functions
$obj->filenameToPackage(FILENAME)
OODoc::Text::Option->filenameToPackage(FILENAME)
$obj->mkdirhier(DIRECTORY)
OODoc::Text::Option->mkdirhier(DIRECTORY)
Manual Repository
$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().
SEE ALSO
This module is part of OODoc distribution version 1.03, built on March 14, 2008. Website: http://perl.overmeer.net/oodoc/
LICENSE
Copyrights 2003-2008 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