/ 
OODoc-0.95
River stage zero No dependents
/ OODoc::Text::Example

NAME

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

INHERITANCE

OODoc::Text::Example
  is an OODoc::Text
  is an 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

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.95. Written by Mark Overmeer (mark@overmeer.net). See the ChangeLog for other contributors.

Copyright (c) 2003-2006 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.