/ 
OODoc-3.02
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.

Extends "DESCRIPTION" in OODoc::Text.

OVERLOADED

Extends "OVERLOADED" in OODoc::Text.

overload: '""' (stringification)

Inherited, see "OVERLOADED" in OODoc::Text

overload: '==' and '!=' (numeric comparison)

Inherited, see "OVERLOADED" in OODoc::Object

overload: 'bool'

Inherited, see "OVERLOADED" in OODoc::Object

overload: 'cmp' (string comparison)

Inherited, see "OVERLOADED" in OODoc::Text

METHODS

Extends "METHODS" in OODoc::Text.

Constructors

Extends "Constructors" in OODoc::Text.

$class->new(%options)

Inherited, see "Constructors" in OODoc::Object

-Option     --Defined in     --Default
 container    OODoc::Text      <required>
 description  OODoc::Text      <empty string>
 linenr       OODoc::Text      <required>
 name         OODoc::Text      undef
 type         OODoc::Text      'Example'
container => OBJECT
description => STRING
linenr => INTEGER
name => STRING
type => STRING

Attributes

Extends "Attributes" in OODoc::Text.

$obj->container( [$object] )

Inherited, see "Attributes" in OODoc::Text

$obj->description()

Inherited, see "Attributes" in OODoc::Text

$obj->extends( [$object] )

Inherited, see "Attributes" in OODoc::Text

$obj->linenr()

Inherited, see "Attributes" in OODoc::Text

$obj->manual()

Inherited, see "Attributes" in OODoc::Text

$obj->name()

Inherited, see "Attributes" in OODoc::Text

$obj->type()

Inherited, see "Attributes" in OODoc::Text

$obj->unique()

Inherited, see "Attributes" in OODoc::Object

$obj->where()

Inherited, see "Attributes" in OODoc::Text

Manual Repository

Extends "Manual Repository" in OODoc::Text.

$obj->addManual($manual)

Inherited, see "Manual Repository" in OODoc::Object

$obj->findManual($name)

Inherited, see "Manual Repository" in OODoc::Object

$obj->mainManual($name)

Inherited, see "Manual Repository" in OODoc::Object

$obj->manuals()

Inherited, see "Manual Repository" in OODoc::Object

$obj->manualsForPackage($name)

Inherited, see "Manual Repository" in OODoc::Object

$obj->packageNames()

Inherited, see "Manual Repository" in OODoc::Object

$obj->publicationIndex()

Inherited, see "Manual Repository" in OODoc::Object

$obj->publish(\%options)

Inherited, see "Manual Repository" in OODoc::Object

Collected

Extends "Collected" in OODoc::Text.

$obj->addExample($object)

Inherited, see "Collected" in OODoc::Text

$obj->examples()

Inherited, see "Collected" in OODoc::Text

$obj->findDescriptionObject()

Inherited, see "Collected" in OODoc::Text

$obj->openDescription()

Inherited, see "Collected" in OODoc::Text

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().

SEE ALSO

This module is part of OODoc version 3.02, built on August 15, 2025. Website: https://perl.overmeer.net/oodoc/

LICENSE

For contributors see file ChangeLog.

This software is copyright (c) 2003-2025 by Mark Overmeer.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.