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

NAME

OODoc::Text::Example - one example for the use of a subroutine

INHERITANCE

 OODoc::Text::Example
   is a OODoc::Text
   is a OODoc::Object

SYNOPSIS

DESCRIPTION

Each OODoc::Text element can have a list of examples, 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::Example->new(OPTIONS)

     Option     --Defined in     --Default
 container    OODoc::Text      <required>
 description  OODoc::Text      ''
 linenr       OODoc::Text      <required>
 name         OODoc::Text      undef
 type         OODoc::Text      'Example'

    . container => OBJECT

    . description => STRING

    . linenr => INTEGER

    . name => STRING

    . type => STRING

Inheritance knowledge

$obj->extends([OBJECT])

Attributes

$obj->container([OBJECT])

$obj->description

$obj->name

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

$obj->mkdirhier(DIRECTORY)

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

Manual Repository

$obj->addManual(MANUAL)

$obj->mainManual(NAME)

$obj->manuals

$obj->manualsForPackage(NAME)

$obj->packageNames

DIAGNOSTICS

Error: manual definition requires manual object

SEE ALSO

This module is part of OODoc distribution version 1.04, built on June 12, 2008. Website: http://perl.overmeer.net/oodoc/

LICENSE

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