Daisuke Murase > Pod-HTMLEmbed-0.04 > Pod::HTMLEmbed::Entry

Download:
Pod-HTMLEmbed-0.04.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Source  

NAME ^

Pod::HTMLEmbed::Entry - pod file object for Pod::HTMLEmbed

SYNOPSIS ^

    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"

METHODS ^

file

Return pod file path.

name

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.

title

Return pod title.

body

Return whole html. See section method showed below for section based html.

sections

Return list of sections. (Array of head1 contents)

section($section_name)

Return section based html.

For example:

    $pod->section('SYNOPSIS');

toc

Return "table of contents" html.

SEE ALSO ^

Pod::HTMLEmbed.

AUTHOR ^

Daisuke Murase typester@cpan.org

COPYRIGHT AND LICENSE ^

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.

syntax highlighting: