PPI::Token::Pod(3)

📦
version 1.284 · 14 versions
, in fedora 44

✨ PPI::Token::Pod ✨

okay so bestie, welcome to the PPI::Token::Pod page — that's section 3 of the User Contributed Perl Documentation, iykyk 💅. It's a tiny little module with a huge job, and honestly? It ate.

🌸 NAME 🌸

PPI::Token::Pod — Sections of POD in Perl documents 🎀

🦋 INHERITANCE 🦋

The family tree, and yes it's giving royal lineage 👑:

PPI::Token::Pod
isa PPI::Token
    isa PPI::Element

💖 DESCRIPTION 💖

So here's the vibe: one single PPI::Token::Pod object represents a complete section of POD documentation inside a Perl document. That's it. That's the whole personality. One token, one whole POD block, no cap. 🫶

🌈 METHODS 🌈

Not me pulling up extra methods — this class serves up some bonus methods <em>on top of</em> the ones its PPI::Token and PPI::Element parent classes already hand over. Generous queen. 👑

🍓 merge @podtokens

The merge constructor takes a bunch of PPI::Token::Pod objects and returns a brand-new object that represents one combined POD block made from the content of all of them. Glow-up via fusion fr fr. ✨

It returns a new PPI::Token::Pod object, or undef on error. (Yeah, it can fail. Respect the undef.) 😭

🧚 lines

The lines method takes the string of POD and breaks it into lines, handing them back to you as a list. Chop chop, one line at a time. 💅

🎀 SUPPORT 🎀

See the support section in the main module. (Yes, that's the whole thing. Go check the main module, bestie.)

👑 AUTHOR 👑

Adam Kennedy <adamk@cpan.org> — iconic, we stan. 💜

Copyright 2001 - 2011 Adam Kennedy.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

The full text of the license can be found in the LICENSE file included with this module.

and that's the whole page, periodt 🫶 this was documented for perl v5.42.0 and stamped 2026-01-17 — so if you're reading this way later, hi, hope the POD still slays 🌸✨💖

📦 where this page comes from