Pod::Weaver::Role::StringFromComment(3)

NAME
Pod::Weaver::Role::StringFromComment - Extract a string from a specially formatted comment

VERSION
version 4.018

OVERVIEW
This role assists Pod::Weaver sections by allowing them to pull strings from the source comments formatted like:

    # KEYNAME: Some string...

This is probably the most familiar to people using lines like the following to allow the Name section to determine a module's abstract:

    # ABSTRACT: Provides the HypnoToad with mind-control powers

It will extract these strings by inspecting the "ppi_document" which must be given.

PERL VERSION SUPPORT
This module has the same support period as perl itself: it supports the two most recent versions of perl. (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.

PRIVATE METHODS
This role supplies only methods meant to be used internally by its consumer.

  _extract_comment_content($ppi_doc, $key)
Given a key, try to find a comment matching "# $key:" in the $ppi_document and return everything but the prefix.

e.g., given a document with a comment in it of the form:

    # ABSTRACT: Yada yada...

...and this is called...

    $self->_extract_comment_content($ppi, 'ABSTRACT')

...it returns to us:

    Yada yada...

AUTHOR
Ricardo SIGNES <rjbs@semiotic.systems>

COPYRIGHT AND LICENSE
This software is copyright (c) 2021 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.