The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
OODoc-0.10
River stage zero No dependents
1 ++
/ OODoc::Text::Option

NAME

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

INHERITANCE

 OODoc::Text::Option
   is a OODoc::Text
   is a 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.

OVERLOADED

overload: '""' (stringification)

overload: '==' and '!='

overload: 'cmp' (string comparison)

METHODS

Constructors

OODoc::Text::Option->new(OPTIONS)

     Option       Defined in       Default                                         
 container    L<OODoc::Text>   L<new(subroutine)|OODoc::Text::Option/"METHODS">
 description  L<OODoc::Text>   C<''>                                           
 linenr       L<OODoc::Text>   <required>                                      
 name         L<OODoc::Text>   undef                                           
 parameters                    <required>                                      
 subroutine                    <required>                                      
 type         L<OODoc::Text>   C<'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().

REFERENCES

See the OODoc website at http://perl.overmeer.net/oodoc/ for more details.

COPYRIGHTS

Module version 0.10. Written by Mark Overmeer (mark@overmeer.net). See the ChangeLog for other contributors.

Copyright (c) 2003 by the author(s). All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.