There is an ongoing outage on the primary CPAN mirror. It is possible to work around the issue by using MetaCPAN as a mirror.

 / 
OODoc-3.04
River stage zero No dependents
/ OODoc::Examples

NAME

OODoc::Examples - check the generated output

SYNOPSIS

# Not code

DESCRIPTION

This manual page does not produce any code, and does not document OODoc: it lists various existing constructs supported by the Markov parser (OODoc::Parser::Markov), to check whether the produced output (POD, HTML or generated via Export) from OODoc is correct.

It is really useful to look at the source of this page on github, metacpan, or in the distribution. https://github.com/markov2/perl5-OODoc/blob/master/lib/OODoc/Examples.pm

METHODS

The chapter names which you can use in the manual-pages are restricted. Only with "podtail", you may add some of your own at the end of the generated manual-page.

Subroutine calls

These are the various code entry points, where tie and overload are weird outliers.

overload: "" (stringify)

tie %hash, $class, %options

$any->classInstanceMethod(%options)

$class->classMethod(%options)

function_name(%options)

$obj->instanceMethod(%options)

$obj->instanceMethod2(%options)

Subroutine description

$obj->subr(%options)

Some descriptive text.

-Option     --Default
 is_optional  "my default"
 is_required  <required>
is_optional => STRING

This is an optional argument.

is_required => STRING

This is a required argument.

example: first example

This is an example for subroutine 'subr'.

example: another example

This is another example for subroutine 'subr'.

Subroutine references

The M tag can be used to make references to Methods (functions, ...) and even parameters and options of them. Much more fine-grained than standard PerlPod. This does understand inheritance.

These may also be in other manual-pages:

Blocks

This is a section, within chapter METHODS.

SubSection

This is a subsection.

SubSubSection

This is a subsubsection.

Block references

In-page links:

In-page links, but now with alternative text:

  • TEXT, links to chapter METHODS

  • TEXT, links to section Blocks

  • TEXT, links to SubSection

  • TEXT, links to SubSubSection

  • TEXT, links to external webpage

DIAGNOSTICS

Error: oops, something went wrong

Errors reflect problems in the running code. Cast by subr()

Fault: ouch, that hurts; system fault: $!

Faults are system errors which make it into errors. Cast by subr()

Info: transfer completed

Info statements usually show at verbose runs, to elaborate on steps made. Cast by subr()

SEE ALSO

This module is part of OODoc version 3.04, built on September 12, 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.