From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

 / 
Pod-Example-0.14
River stage one • 2 direct dependents • 2 total dependents
⭐ Starred 0 GitHub stars
/ Pod::Example

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 ($example, $filename) = get($file_or_module[, $section[, $number_of_example]]);
my @sections = sections($file_or_module[, $section]);

SUBROUTINES

get


            

              
              
my $example = get($file_or_module[, $section[, $number_of_example]]);
my ($example, $filename) = get($file_or_module[, $section[, $number_of_example]]);

Get content of example. If detect POD comment with filename=FILENAME returns filename string. It's useful for generating of examples from documentation.

Returns code of example in scalar mode.

Returns list with code of example and filename (if possible) in array mode.


            

              
              
$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. If exists 'EXAMPLE1' and 'EXAMPLE2'
                     sections, then this number can be '1' or '2'.
                     Default value is nothing.

sections


            

              
              
my @sections = 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


            

              
              
get():
        Cannot open pod file or Perl module.
sections():
        Cannot open pod file or Perl module.

EXAMPLE1


            

              
              
use strict;
use warnings;
use Pod::Example qw(get);
# Get and print code.
print get('Pod::Example')."\n";
# Output:
# This example.

EXAMPLE2


            

              
              
use strict;
use warnings;
use Pod::Example qw(sections);
# Get and print code.
print join "\n", sections('Pod::Example');
print "\n";
# Output:
# EXAMPLE1
# EXAMPLE2

DEPENDENCIES

Error::Pure, Exporter, Pod::Abstract, Pod::Find, Readonly.

SEE ALSO

pod-example

Script to print or run of example from documentation.

App::Pod::Example

Base class for pod-example script.

REPOSITORY

https://github.com/michal-josef-spacek/Pod-Example

AUTHOR

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

http://skim.cz

LICENSE AND COPYRIGHT

© 2011-2023 Michal Josef Špaček

BSD 2-Clause License

VERSION

0.14