/ 
OODoc-2.02
River stage zero No dependents
/ OODoc::Text::Option

NAME

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

INHERITANCE

OODoc::Text::Option
  is an OODoc::Text
  is an OODoc::Object

SYNOPSIS

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.

Extends "DESCRIPTION" in OODoc::Text.

OVERLOADED

Extends "OVERLOADED" in OODoc::Text.

overload: '""' <$stringification>

Inherited, see "OVERLOADED" in OODoc::Text

overload: '==' $and '!='

Inherited, see "OVERLOADED" in OODoc::Text

overload: 'cmp' <$string $comparison>

Inherited, see "OVERLOADED" in OODoc::Text

METHODS

Extends "METHODS" in OODoc::Text.

Constructors

Extends "Constructors" in OODoc::Text.

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

Extends "Inheritance knowledge" in OODoc::Text.

$obj->extends( [$object] )

Inherited, see "Inheritance knowledge" in OODoc::Object

Attributes

Extends "Attributes" in OODoc::Text.

$obj->container( [$object] )

Inherited, see "Attributes" in OODoc::Text

$obj->description()

Inherited, see "Attributes" in OODoc::Text

$obj->name()

Inherited, 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()

Inherited, see "Attributes" in OODoc::Text

Location

Extends "Location" in OODoc::Text.

$obj->manual( [$name] )

Inherited, see "Location" in OODoc::Text

$obj->unique()

Inherited, see "Location" in OODoc::Text

$obj->where()

Inherited, see "Location" in OODoc::Text

Collected

Extends "Collected" in OODoc::Text.

$obj->example($object)

Inherited, see "Collected" in OODoc::Text

$obj->examples()

Inherited, see "Collected" in OODoc::Text

$obj->findDescriptionObject()

Inherited, see "Collected" in OODoc::Text

$obj->openDescription()

Inherited, see "Collected" in OODoc::Text

Commonly used functions

Extends "Commonly used functions" in OODoc::Text.

$obj->filenameToPackage($filename)
OODoc::Text::Option->filenameToPackage($filename)

Inherited, see "Commonly used functions" in OODoc::Object

$obj->mkdirhier($directory)
OODoc::Text::Option->mkdirhier($directory)

Inherited, see "Commonly used functions" in OODoc::Object

Manual Repository

Extends "Manual Repository" in OODoc::Text.

$obj->addManual($manual)

Inherited, see "Manual Repository" in OODoc::Object

$obj->mainManual($name)

Inherited, see "Manual Repository" in OODoc::Object

$obj->manuals()

Inherited, see "Manual Repository" in OODoc::Object

$obj->manualsForPackage($name)

Inherited, see "Manual Repository" in OODoc::Object

$obj->packageNames()

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

SEE ALSO

This module is part of OODoc distribution version 2.02, built on December 08, 2021. Website: http://perl.overmeer.net/oodoc/

LICENSE

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