OODoc::Text::Option - one option for one subroutine
OODoc::Text::Option is an OODoc::Text is an OODoc::Object
Each OODoc::Text::Subroutine can have a list of options, which are each captured in a separate object as described in this manual page.
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.
-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'
An informal short description of the valid values for this option.
The subroutine in which this option lives.
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 short, informal description of the valid parameters for this option.
Returns the subroutine object for this option.
Extends "Location" in OODoc::Text.
Inherited, see "Location" in OODoc::Text
Extends "Collected" in OODoc::Text.
Inherited, see "Collected" in OODoc::Text
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.02, built on December 08, 2021. Website: http://perl.overmeer.net/oodoc/
Copyrights 2003-2021 by [Mark Overmeer]. For other contributors see ChangeLog.
This program is free software; you can redistribute it and/or modify it under the Artistic license. See http://dev.perl.org/licenses/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.