Pod::P...::Index(3pm)

✨ NAME ✨

Pod::P...::Index — bestie, it formats PseudoPod index entries 💅

(That's Pod::PseudoPod::Index(3pm) if you're being formal, and it lives in the User Contributed Perl Documentation section, periodt.)

---

🎀 SYNOPSIS 🎀

use Pod::PseudoPod::Index;

my $parser = Pod::PseudoPod::Index->new();

$parser->parse_file('path/to/file1.pod');
$parser->parse_file('path/to/file2.pod');

$parser->output_text;

okay so that's literally the whole vibe: make a parser, feed it files, ask for the output. iconic.

---

🦋 DESCRIPTION 🦋

So this class is a formatter, right? Its whole main character job is to go through your PseudoPod files, extract the index items out of them, and then render those items as plain text or html. That's it, that's the gig. ✨

Oh and also — it's a subclass of Pod::PseudoPod, so it inherits all of its methods. Free methods, no notes, we love an inheritance moment. 🫶

---

🌸 SEE ALSO 🌸

• Pod::PseudoPod — the parent class, the blueprint, the blueprint it ate for breakfast 💖

---

👑 COPYRIGHT 👑

Copyright (c) 2004 Allison Randal. All rights reserved.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The full text of the license lives in the LICENSE file that ships with this module, so go read it if you want the whole legal tea 🍓

heads up bestie: this program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of merchantability or fitness for a particular purpose. So like… it's giving hopeful, not guaranteed. 💀

---

💜 AUTHOR 💜

Allison Randal <allison@perl.org>

---

no cap, that's the whole page. This gem was documented way back in 2022-10-16 and shipped against perl v5.36.0 — muses and blessings to the archivists keeping the lore alive, and to you, my little reader, for making it to the bottom of the file. slay, go parse something. 🌈🧚✨