Pod::HTMLEmbed::Entry - pod file object for Pod::HTMLEmbed
use Pod::HTMLEmbed; my $pod = Pod::HTMLEmbed->new->find('Moose'); $pod->name; # => 'Moose' $pod->title; # => 'A postmodern object system for Perl 5' $pod->section('SYNOPSIS'); # => html for Moose's SYNOPSIS $pod->sections; # => Moose's pod section list: NAME, SYNOPSIS, DESCRIPTION... $pod->toc; # html for "Table of contents"
Return pod file path.
Return pod name. This is generated by NAME section.
For example,
=head1 NAME Pod::HTMLEmbed - Make clean html snippets from POD
This documents name is Pod::HTMLEmbed. And Make clean html snippets from POD is title showed below.
name
Pod::HTMLEmbed
Make clean html snippets from POD
title
Return pod title.
Return whole html. See section method showed below for section based html.
section
Return list of sections. (Array of head1 contents)
Return section based html.
For example:
$pod->section('SYNOPSIS');
Return "table of contents" html.
Pod::HTMLEmbed.
Daisuke Murase typester@cpan.org
typester@cpan.org
Copyright (c) 2009 by KAYAC Inc.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
The full text of the license can be found in the LICENSE file included with this module.
To install Pod::HTMLEmbed, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Pod::HTMLEmbed
CPAN shell
perl -MCPAN -e shell install Pod::HTMLEmbed
For more information on module installation, please visit the detailed CPAN module installation guide.