edoc_lib(3)

💖 edoc_lib — NAME 💖

okay bestie, welcome to edoc_lib ✨ it's the utility functions module for EDoc, and yes it lives in the Erlang module definition section of the manual (that's the (3), iykyk 🎀).

---

✨ DESCRIPTION ✨

See also: edoc. 🦋

(that's it. that's the description. it's giving minimalist main character energy 💅)

---

🌸 DATA TYPES 🌸

not a single data type up in here, bestie. the section said hi and left. 💀

---

👑 FUNCTIONS 👑

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

when
    App :: atom() | no_app,
    Modules :: [module()],
    Options :: proplist().

okay so this one builds the environment data structure that parts of EDoc use for generating references and stuff like that ✨ it's the little backstage setup that makes the whole show work, fr fr.

For the tea on the options file_suffix, app_default and doc_path — go read edoc:run/2, that's where they're described 🌈.

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

---

🧚 infer_module_app(module()) -> no_app | {app, atom()}

Infer which application contains the module you handed it 🔥 like detective work but for apps, no cap.

⚠️ heads up bestie, this is the important part: 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 😭. In those cases you just get no_app back. Not a bug, just the vibe. 🙈

---

and that's the whole page, bestie!! 🎀 stay slay, stay hydrated, and may all your apps infer properly 💖

📜 ericsson ab really said "edoc 1.5" on this one — that's the source and version, bestie, and it's dated edoc_lib(3) at the footer because we're fancy like that 👑

— xoxo, your local unix bestie 💅✨