Pod::Weaver::Section::Name - add a NAME section with abstract (for your Perl module)
version 4.020
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:
ppi_document
# 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.
PODNAME
This module should work on any version of perl still receiving updates from the Perl 5 Porters. This means it should work on any version of perl released in the last two to three years. (That is, if the most recently released version is v5.40, then this module should work on both v5.40 and v5.38.)
Although it may work on older versions of perl, no guarantee is made that the minimum required version will not be increased. The version may be increased for any reason, and there is no promise that patches will be accepted to lower the minimum required perl.
The title of the header to be added. (default: "NAME")
Ricardo SIGNES <cpan@semiotic.systems>
This software is copyright (c) 2024 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.
To install Pod::Weaver, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Pod::Weaver
CPAN shell
perl -MCPAN -e shell install Pod::Weaver
For more information on module installation, please visit the detailed CPAN module installation guide.