Michal Špaček > Pod-Example-0.04 > Pod::Example

Download:
Pod-Example-0.04.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 0.04   Source   Latest Release: Pod-Example-0.05

NAME ^

Pod::Example - Module for getting example from POD.

SYNOPSIS ^

 use Pod::Example qw(get sections);
 my $example = get($file_or_module[, $section[, $number_of_example]]);
 my @sections = sections($file_or_module[, $section]);

SUBROUTINES ^

get($file_or_module[, $section[, $number_of_example]])
 Returns code of example.
 $file_or_module - File with pod doc or perl module.
 $section - Pod section with example. Default value is 'EXAMPLE'.
 $number_of_example - Number of example. Default value is first example.
sections($file_or_module[, $section])
 Returns array of example sections.
 $file_or_module - File with pod doc or perl module.
 $section - Pod section with example. Default value is 'EXAMPLE'.

ERRORS ^

 Mine:
         Cannot open pod file or Perl module.

EXAMPLE1 ^

 # Pragmas.
 use strict;
 use warnings;

 # Modules.
 use Pod::Example qw(get);

 # Get and print code.
 print get('Pod::Example')."\n";

 # Output:
 # This example.

EXAMPLE2 ^

 # Pragmas.
 use strict;
 use warnings;

 # Modules.
 use Pod::Example qw(sections);

 # Get and print code.
 print join "\n", sections('Pod::Example');
 print "\n";

 # Output:
 # EXAMPLE1
 # EXAMPLE2

DEPENDENCIES ^

Error::Pure, Exporter, Module::Info, Pod::Abstract, Readonly.

REPOSITORY ^

https://github.com/tupinek/Pod-Example

AUTHOR ^

Michal Špaček mailto:skim@cpan.org

http://skim.cz

LICENSE AND COPYRIGHT ^

BSD license.

VERSION ^

0.04

syntax highlighting: