1Pod::Weaver::Section::NUasmeer(3C)ontributed Perl DocumePnotda:t:iWoenaver::Section::Name(3)
2
3
4
6 Pod::Weaver::Section::Name - add a NAME section with abstract (for your
7 Perl module)
8
10 version 4.019
11
13 This section plugin will produce a hunk of Pod giving the name of the
14 document as well as an abstract, like this:
15
16 =head1 NAME
17
18 Some::Document - a document for some
19
20 It will determine the name and abstract by inspecting the
21 "ppi_document" which must be given. It looks for comments in the form:
22
23 # ABSTRACT: a document for some
24 # PODNAME: Some::Package::Name
25
26 If no "PODNAME" comment is present, but a package declaration can be
27 found, the package name will be used as the document name.
28
30 This module should work on any version of perl still receiving updates
31 from the Perl 5 Porters. This means it should work on any version of
32 perl released in the last two to three years. (That is, if the most
33 recently released version is v5.40, then this module should work on
34 both v5.40 and v5.38.)
35
36 Although it may work on older versions of perl, no guarantee is made
37 that the minimum required version will not be increased. The version
38 may be increased for any reason, and there is no promise that patches
39 will be accepted to lower the minimum required perl.
40
42 header
43 The title of the header to be added. (default: "NAME")
44
46 Ricardo SIGNES <cpan@semiotic.systems>
47
49 This software is copyright (c) 2023 by Ricardo SIGNES.
50
51 This is free software; you can redistribute it and/or modify it under
52 the same terms as the Perl 5 programming language system itself.
53
54
55
56perl v5.36.0 2023-01-20 Pod::Weaver::Section::Name(3)