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.018
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 has the same support period as perl itself: it supports
31 the two most recent versions of perl. (That is, if the most recently
32 released version is v5.40, then this module should work on both v5.40
33 and v5.38.)
34
35 Although it may work on older versions of perl, no guarantee is made
36 that the minimum required version will not be increased. The version
37 may be increased for any reason, and there is no promise that patches
38 will be accepted to lower the minimum required perl.
39
41 header
42 The title of the header to be added. (default: "NAME")
43
45 Ricardo SIGNES <rjbs@semiotic.systems>
46
48 This software is copyright (c) 2021 by Ricardo SIGNES.
49
50 This is free software; you can redistribute it and/or modify it under
51 the same terms as the Perl 5 programming language system itself.
52
53
54
55perl v5.34.0 2022-01-21 Pod::Weaver::Section::Name(3)