Syntax::POD(3pm)

💖 Syntax::POD 💖

okay bestie, gather round, because we're talking about Embperl::Syntax::POD — the little icon that takes your Perl POD files and turns them into XML on the fly. it lives in the User Contributed Perl Documentation corner of the manual, and honestly? it's giving backstage-pass energy. 🎀

---

✨ SYNOPSIS ✨

no cap, there's literally nothing here in the original. the synopsis is an empty room and we're all just vibing in it. 💀

---

🌸 DESCRIPTION 🌸

so this class is derived from Embperl::Syntax, and what it does is convert Perl Plain Old Documentation (POD) files on the fly into XML. like, mid-read. no pre-processing era, we're doing it live. 🦋

it's used for generating the Embperl online documentation from the Embperl POD files. if you wanna see how to actually use it, peek at the eg directory in the distribution — there's an example waiting for you there like a little gift. 🎁

---

😭 TODO 😭

bestie. the documentation of the resulting XML format... still has to be written. that's it. that's the todo. it's giving unfinished homework and we're all just pretending we don't see it. 🙈

---

👑 Methods 👑

Embperl::Syntax::POD defines the following methods:

💅 Embperl::Syntax::POD -> new / $self -> new

create a new syntax class. ✨

heads up: this method should only be called inside a constructor of a derived class. don't be out here calling it wherever, iykyk. 🙅♀️

💅 AddPODCmd ($cmdname, $procinfo)

add a new POD command with name $cmdname and use processor info from $procinfo. 💖

see Embperl::Syntax for a definition of procinfo.

💅 AddPODCmdStartEnd ($cmdname, $endname, $procinfo)

add a new POD command with name $cmdname and use processor info from $procinfo. 🌈

additionally, you specify that a matching $endname POD command must be found to end the block that is started by this POD command. so it's a two-part situation — one command opens the vibe, the other one closes it. periodt. 🔥

see Embperl::Syntax for a definition of procinfo.

---

🌟 Author 🌟

G. Richter (richter at embperl dot org) — the main character who wrote all this. 👑

---

🫶 See Also 🫶

• Embperl::Syntax

---

and that's the whole page, bestie!! 💜 this little gem ships as part of perl v5.34.0, dated 2022-02-06 — so yeah, it's been slaying since way back. go forth and convert that POD to XML, you absolute legend. 🧚‍♀️⭐🍓