.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Pod::Weaver::Role::StringFromComment 3pm"
.TH Pod::Weaver::Role::StringFromComment 3pm "2016-10-22" "perl v5.24.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Pod::Weaver::Role::StringFromComment \- Extract a string from a specially formatted comment
.SH "VERSION"
.IX Header "VERSION"
version 4.015
.SH "OVERVIEW"
.IX Header "OVERVIEW"
This role assists Pod::Weaver sections by
allowing them to pull strings from the source comments formatted like:
.PP
.Vb 1
\&    # KEYNAME: Some string...
.Ve
.PP
This is probably the most familiar to people using lines like the following to
allow the Name section to determine a module's
abstract:
.PP
.Vb 1
\&    # ABSTRACT: Provides the HypnoToad with mind\-control powers
.Ve
.PP
It will extract these strings by inspecting the \f(CW\*(C`ppi_document\*(C'\fR which
must be given.
.SH "PRIVATE METHODS"
.IX Header "PRIVATE METHODS"
This role supplies only methods meant to be used internally by its consumer.
.ie n .SS "_extract_comment_content($ppi_doc, $key)"
.el .SS "_extract_comment_content($ppi_doc, \f(CW$key\fP)"
.IX Subsection "_extract_comment_content($ppi_doc, $key)"
Given a key, try to find a comment matching \f(CW\*(C`# $key:\*(C'\fR in the \f(CW$ppi_document\fR
and return everything but the prefix.
.PP
e.g., given a document with a comment in it of the form:
.PP
.Vb 1
\&    # ABSTRACT: Yada yada...
.Ve
.PP
\&...and this is called...
.PP
.Vb 1
\&    $self\->_extract_comment_content($ppi, \*(AqABSTRACT\*(Aq)
.Ve
.PP
\&...it returns to us:
.PP
.Vb 1
\&    Yada yada...
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Ricardo \s-1SIGNES\s0 <rjbs@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2016 by Ricardo \s-1SIGNES.\s0
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.