Pod::W...omment(3pm)

💖 NAME 💖

okay so bestie, welcome to the Pod::W...omment(3pm) page — yes, that's the manual-name situation up top, filed under User Contributed Perl Documentation. The actual star of the show is Pod::Weaver::Role::StringFromComment, and its whole job is extracting a string from a specially formatted comment. Periodt. ✨

🎀 VERSION 🎀

version 4.020 — that's the one, bestie. 💅

🌸 OVERVIEW 🌸

This role assists Pod::Weaver sections by letting them pull strings from source comments formatted like this:

# KEYNAME: Some string...

This is probably the most familiar to people using lines like the following to let the Name section 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. No ppi_document, no vibe. 🫶

🦋 PERL VERSION 🦋

This module should work on any version of perl still receiving updates from the Perl 5 Porters. This means it should work on any version of perl released in the last two to three years. (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. So like, don't come for the minimum version unless it's in the cards, okay? 😭

💅 PRIVATE METHODS 💅

This role supplies only methods meant to be used internally by its consumer. So these are backstage methods, not main-character public API. 👑

🔥 _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 <cpan@semiotic.systems>

🌈 COPYRIGHT AND LICENSE 🌈

This software is copyright (c) 2024 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.

---

okay that's the whole page, bestie — signing off from the Pod::W...omment(3pm) corner of the group chat, with perl v5.38.2 and the date 2024-03-24 doing their little footer dance. 💖✨