1Pod::Weaver::Role::StriUnsgeFrroCmoCnotmrmiebnutt(e3d)PPeordl::DWoecauvmeern:t:aRtoiloen::StringFromComment(3)
2
3
4

NAME

6       Pod::Weaver::Role::StringFromComment - Extract a string from a
7       specially formatted comment
8

VERSION

10       version 4.015
11

OVERVIEW

13       This role assists Pod::Weaver sections by allowing them to pull strings
14       from the source comments formatted like:
15
16           # KEYNAME: Some string...
17
18       This is probably the most familiar to people using lines like the
19       following to allow the Name section to determine a module's abstract:
20
21           # ABSTRACT: Provides the HypnoToad with mind-control powers
22
23       It will extract these strings by inspecting the "ppi_document" which
24       must be given.
25

PRIVATE METHODS

27       This role supplies only methods meant to be used internally by its
28       consumer.
29
30   _extract_comment_content($ppi_doc, $key)
31       Given a key, try to find a comment matching "# $key:" in the
32       $ppi_document and return everything but the prefix.
33
34       e.g., given a document with a comment in it of the form:
35
36           # ABSTRACT: Yada yada...
37
38       ...and this is called...
39
40           $self->_extract_comment_content($ppi, 'ABSTRACT')
41
42       ...it returns to us:
43
44           Yada yada...
45

AUTHOR

47       Ricardo SIGNES <rjbs@cpan.org>
48

50       This software is copyright (c) 2016 by Ricardo SIGNES.
51
52       This is free software; you can redistribute it and/or modify it under
53       the same terms as the Perl 5 programming language system itself.
54
55
56
57perl v5.28.1                      2016-1P0o-d1:5:Weaver::Role::StringFromComment(3)
Impressum