lfe_docs(3)

🌸 NAME 🌸

okay so bestie, this is the manual page for lfe_docs(3) — aka the lfe_docs module, and it’s literally Lisp Flavoured Erlang (LFE) documentation handling. 💅✨

✨ SYNOPSIS ✨

This module provides functions to parse docstrings in LFE module sources in EEP48 format. no cap. 🫶

🎀 EXPORTS 🎀

• make_chunk(Mod, CompilerInfo) -> {ok,DocsChunk} — parse a module’s docstrings and return a documentation chunk. slay. 💖
• make_docs_info(Mod, CompilerInfo) -> {ok,DocsInfo} — parse a module’s docstrings and return the documentation info. ✨
• get_module_docs(Module | Binary) -> {ok,DocsInfo} | {error,Error} — extract the documentation from a module documentation chunk and return it in the documentation format of the current Erlang version. iconic. 👑

🌈 SEE ALSO 🌈

• lfe_comp(3)
• lfe_macro(3)

👑 AUTHORS 👑

Robert Virding. 💜

💖 ok bye bestie — footer vibes are lfe_docs(3) and 2016, and you ate the whole page. periodt. 🎀🦋