table of contents
Pod::Weaver::Section::Name(3pm) | User Contributed Perl Documentation | Pod::Weaver::Section::Name(3pm) |
NAME¶
Pod::Weaver::Section::Name - add a NAME section with abstract (for your Perl module)
VERSION¶
version 4.015
OVERVIEW¶
This section plugin will produce a hunk of Pod giving the name of the document as well as an abstract, like this:
=head1 NAME Some::Document - a document for some
It will determine the name and abstract by inspecting the "ppi_document" which must be given. It looks for comments in the form:
# ABSTRACT: a document for some # PODNAME: Some::Package::Name
If no "PODNAME" comment is present, but a package declaration can be found, the package name will be used as the document name.
ATTRIBUTES¶
header¶
The title of the header to be added. (default: "NAME")
AUTHOR¶
Ricardo SIGNES <rjbs@cpan.org>
COPYRIGHT AND LICENSE¶
This software is copyright (c) 2016 by Ricardo SIGNES.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
2016-10-22 | perl v5.24.1 |