Marcel Grünauer > Pod-Generated-0.05 > Template::Plugin::PodGenerated

Download:
Pod-Generated-0.05.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

Open  1
View/Report Bugs
Module Version: 0.05   Source  

NAME ^

Template::Plugin::PodGenerated - Template plugin to help generate POD

SYNOPSIS ^

    {% USE p = PodGenerated %}

    =head1 NAME

    {% p.package %} - Definition of what this module does

    =head1 SYNOPSIS

        {% p.package %}->new;

    =head1 DESCRIPTION

    =head1 METHODS

    =over 4

    {% p.write_methods %}

    =back

    {% p.write_inheritance %}

    {% PROCESS standard_pod_zid %}

    =cut

DESCRIPTION ^

This is a plugin for the Template Toolkit that you can use to generate POD documentation during make time.

To understand the concepts behind this, please read the documentation of Module::Install::Template and Pod::Generated.

When this plugin is loaded in a template - using USE p = PodGenerated, for example - it evaluates the template's source code - which it has by magic of Module::Install::Template - so it gives participating modules a chance to generate documentation. For example, if your module uses Class::Accessor::Complex, documentation for the generated accessors will be generated during this time.

This plugin provides the following methods to be used in templates:

package

The current package name as parsed from the source code.

write_inheritance

Information about which classes the current class inherits from and which methods it inherits, as far as known. Only those methods in superclasses for which documentation has also been generated are found through this mechanism.

This might be improved at some point.

write_methods

Write the documentation for the methods in the current package that have documentation defined for it.

TAGS ^

If you talk about this module in blogs, on delicious.com or anywhere else, please use the podgenerated tag.

BUGS AND LIMITATIONS ^

No bugs have been reported.

Please report any bugs or feature requests to bug-pod-generated@rt.cpan.org, or through the web interface at http://rt.cpan.org.

INSTALLATION ^

See perlmodinstall for information and options on installing Perl modules.

AVAILABILITY ^

The latest version of this module is available from the Comprehensive Perl Archive Network (CPAN). Visit <http://www.perl.com/CPAN/> to find a CPAN site near you. Or see http://search.cpan.org/dist/Pod-Generated/.

AUTHOR ^

Marcel Grünauer, <marcel@cpan.org>

COPYRIGHT AND LICENSE ^

Copyright 2007-2009 by Marcel Grünauer

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

syntax highlighting: