edoc_lib(3erl)

💖 NAME 💖

okay so this is edoc_lib(3erl), and the manual name is literally Erlang Module Definition — we're in Erlang land, bestie.

edoc_lib — utility functions for EDoc. Short, sweet, iconic.

---

✨ DESCRIPTION ✨

Utility functions for EDoc. That's the whole description, and honestly? It's giving minimal main character energy. No cap.

---

🎀 DATA TYPES 🎀

There is exactly one type alias on this page, and it is literally this:

proplist() = proplists:proplist():

Copy it exactly, trailing colon included. Don't come for me 💅

---

👑 EXPORTS 👑

Three exports. We are going through every single one, no skipping, periodt.

💜 get_doc_env(App, Modules, Options) -> edoc:env()

Types:

App = atom() | no_app
Modules = [module()]
Options = proplist()

This one creates an environment data structure used by parts of EDoc for generating references, etc.

See edoc:run/2 for a description of the options file_suffix, app_default and doc_path.

See also: edoc:get_doc/3, edoc_extract:source/4.

🦋 infer_module_app(Mod::module()) -> no_app | {app, atom()}

Infer application containing the given module.

Heads up bestie: it's expected that modules which are not preloaded and don't match the <app>/ebin/<mod>.beam path pattern will NOT have an app name inferred properly. no_app is returned in such cases.

That's the whole vibe check for this one.

🌸 write_file(Text, Dir, Name, Options) -> term()

This entry is literally just the signature — the page gives no types block and no description, so I'm not gonna invent one for clout. It takes Text, Dir, Name, Options and returns term(). That's all we've got, bestie.

---

🌈 SEE ALSO 🌈

edoc — that's it. Go read that one next, iykyk.

---

🫶 AUTHORS 🫶

Made by Richard Carlsson <carlsson.richard@gmail.com> — iconic.

---

muah 💋 this page is from edoc 1.2 (the footer's source/version), and the footer doesn't give a date, so no fake date from me. Manual tag: edoc_lib(3erl). Bye bestie 🎀