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::Default

NAME

OODoc::Text::Default - one default for an option in one subroutine

INHERITANCE

 OODoc::Text::Default
   is a OODoc::Text
   is a OODoc::Object

SYNOPSIS

DESCRIPTION

Each OODoc::Text::Subroutine can have a list of options, which have default values 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::Default->new(OPTIONS)

     Option       Defined in       Default                                          
 container    L<OODoc::Text>   L<new(subroutine)|OODoc::Text::Default/"METHODS">
 description  L<OODoc::Text>   C<''>                                            
 linenr       L<OODoc::Text>   <required>                                       
 name         L<OODoc::Text>   undef                                            
 subroutine                    <required>                                       
 type         L<OODoc::Text>   C<'Default'>                                     
 value                         <required>

    . container OBJECT

    . description STRING

    . linenr INTEGER

    . name STRING

    . subroutine OBJECT

      The subroutine in which this option lives.

    . type STRING

    . value STRING

      The value which is related to this default.

Inheritance knowledge

$obj->extends([OBJECT])

Attributes

$obj->container([OBJECT])

$obj->description

$obj->name

$obj->subroutine

    Returns the subroutine object for this option.

$obj->type

$obj->value

    The value of this default.

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::Default->filenameToPackage(FILENAME)

$obj->mkdirhier(DIRECTORY)

OODoc::Text::Default->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.