edoc_doclet_chunks(3)

💖 edoc_doclet_chunks — the Erlang module that gives you standalone doc chunks 💖

okay bestie, welcome to edoc_doclet_chunks, an Erlang module definition, part of the edoc family. she's a doclet, she's cute, and she writes files. let's get into it ✨

---

🌸 NAME 🌸

edoc_doclet_chunks — a doclet that generates standalone EEP-48 doc chunk files 💅

🦋 DESCRIPTION 🦋

There's a section called Using the EDoc API in the EDoc User's Guide that shows an example of using this module, so if you wanna see her in action, that's where to look 🫶

Also pls go say hi to:

• edoc_layout_chunks
• //stdlib/shell_docs

like, they're her people, iykyk 🌈

---

👑 FUNCTIONS 👑

✨ run(edoc_doclet:command(), edoc_doclet:context()) -> ok. ✨

This is the main doclet entry point. the whole vibe, the main character moment, the place where everything starts 🔥

Heads up bestie, because this part matters: this doclet is tightly coupled with edoc_layout_chunks and she should be used together with it. they're a package deal, no cap 🤝

And the only option this doclet accepts is dir, which controls where the chunks subdirectory and the EEP-48 chunk files will be placed. that's it, that's the whole option list, she's lowkey minimal 💀

literally just dir. don't come at her with extra flags, she will not accept them 🙈

---

and that's the whole page, bestie!! go forth and generate some chunks 🎀🦋💖

this one came to you from Ericsson AB, running edoc 1.5 — mwah, take care of her ✨💅