NAME

OODoc::Text::Option - one option for one subroutine

INHERITANCE

 OODoc::Text::Option
   is a OODoc::Text
   is a OODoc::Object

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): See "OVERLOADED" in OODoc::Text
overload: '==' and '!=': See "OVERLOADED" in OODoc::Text
overload: 'cmp' (string comparison): See "OVERLOADED" in OODoc::Text

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]): See "Inheritance knowledge" in OODoc::Object

Attributes

$obj->container([OBJECT]): See "Attributes" in OODoc::Text
$obj->description: See "Attributes" in OODoc::Text
$obj->name: See "Attributes" in OODoc::Text
$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: See "Attributes" in OODoc::Text

Location

$obj->manual([NAME]): See "Location" in OODoc::Text
$obj->unique: See "Location" in OODoc::Text
$obj->where: See "Location" in OODoc::Text

Collected

$obj->example(OBJECT): See "Collected" in OODoc::Text
$obj->examples: See "Collected" in OODoc::Text
$obj->findDescriptionObject: See "Collected" in OODoc::Text
$obj->openDescription: See "Collected" in OODoc::Text

Commonly used functions

$obj->filenameToPackage(FILENAME)

OODoc::Text::Option->filenameToPackage(FILENAME)

See "Commonly used functions" in OODoc::Object

$obj->mkdirhier(DIRECTORY)

OODoc::Text::Option->mkdirhier(DIRECTORY)

See "Commonly used functions" in OODoc::Object

Manual Repository

$obj->addManual(MANUAL): See "Manual Repository" in OODoc::Object
$obj->mainManual(NAME): See "Manual Repository" in OODoc::Object
$obj->manuals: See "Manual Repository" in OODoc::Object
$obj->manualsForPackage(NAME): See "Manual Repository" in OODoc::Object
$obj->packageNames: See "Manual Repository" in OODoc::Object

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().

LICENSE

Copyrights 2003-2011 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