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

NAME

OODoc::Text::Subroutine - collects information about one documented sub

INHERITANCE

 OODoc::Text::Subroutine
   is a OODoc::Text
   is a OODoc::Object

SYNOPSIS

DESCRIPTION

Perl has various things we can call "sub" (for "subroutine") one way or the other. This object tries to store all types of them: methods, funtion, ties, and overloads. Actually, these are the most important parts of the documentation. The share more than they differ.

OVERLOADED

overload: '""' (stringification)

overload: '==' and '!='

overload: 'cmp' (string comparison)

METHODS

Constructors

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

     Option       Defined in       Default   
 container    L<OODoc::Text>   <required>
 description  L<OODoc::Text>   C<''>     
 linenr       L<OODoc::Text>   <required>
 name         L<OODoc::Text>   undef     
 parameters                    undef     
 type         L<OODoc::Text>   <required>

    . container OBJECT

    . description STRING

    . linenr INTEGER

    . name STRING

    . parameters STRING

    . type STRING

Inheritance knowledge

$obj->extends([OBJECT])

Attributes

$obj->container([OBJECT])

$obj->description

$obj->name

$obj->parameters

    The parameter list for the subroutine is returned as string. The result may be undef or empty.

$obj->type

Location

$obj->location(MANUAL)

    Try to figure-out what the location for the subroutine is within the MANUAL page. Have a look at all levels of extension for this sub-routine's documentation and decides the best enclosing chapter, section and subsection. Then return that object for the current manual.

$obj->manual([NAME])

$obj->path

    Returns the path of the text structure which contains this subroutine.

$obj->unique

$obj->where

Collected

$obj->collectedOptions

    Returns a list of option-default combinations on this subroutine.

$obj->default(NAME|OBJECT)

    In case of a NAME, a default object for this method is looked up. This does not search through super classes, but solely which is defined with this subroutine. When passed an OBJECT of type OODoc::Text::Default that will be stored.

$obj->defaults

    Returns a list of all defaults as defined by this documentation item in one manual.

$obj->diagnostic(OBJECT)

    Add a new diagnostic message (a OODoc::Text::Diagnostic object) to the list already in this object. You can not look for a message because these names are without use.

$obj->diagnostics

    Returns a list of all diagnostics.

$obj->example(OBJECT)

$obj->examples

$obj->findDescriptionObject

$obj->findOption(NAME)

    Does a little more thorough job than option() bu searching the inherited options for this subroutine as well.

$obj->openDescription

$obj->option(NAME|OBJECT)

    In case of a NAME, the option object for this method is looked up. This does not search through super classes, but solely which is defined with this subroutine. When passed an OBJECT of type OODoc::Text::Option that will be stored.

$obj->options

    Returns a list of all options as defined by this documentation item in one manual.

Commonly used functions

$obj->filenameToPackage(FILENAME)

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

$obj->mkdirhier(DIRECTORY)

OODoc::Text::Subroutine->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().

Warning: subroutine $name extended by different type:

Any description of a subroutine classifies it as method, tie, overload or whatever. Apparently, this indicated subroutine is defined being of a different type on these both places, and there is an inheritance relation between these places.

In very rare cases, this warning can be ignored, but usually these situation is errorneous of confusing for the users of the library.

Warning: subroutine $self location conflict: $here $super

The location of subroutine descriptions must be consistent over the manual pages. You may change the level of clearness about the exact location (place in the chapter in one page, and in a subsection in the next), as long as it is not conflicting (the subsection must be a part of the chapter).

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.