edoc_doclet(3erl)

🌸 edoc_doclet(3erl) — Erlang Module Definition 🌸

🌸 NAME 🌸

edoc_doclet — Standard doclet module for EDoc. That's the whole name tea, bestie 💅✨

🦋 DESCRIPTION 🦋

Okay so real talk: the way that edoc_doclet is the standard doclet module for EDoc is iconic. That's the description, and it ate 🫶💖

🧚 DATA TYPES 🧚

• command() — Doclet commands. The type is literally:

command() = doclet_gen() | doclet_toc()

• context() — Context for doclets:

context() = #doclet_context{dir=string(), env=edoc:env(), opts=[term()]}

• doclet_gen() — Doclet command:

doclet_gen() = #doclet_gen{sources=[string()], app=no_app | atom(), modules=[module()]}

• doclet_toc() — Doclet command:

doclet_toc() = #doclet_toc{paths=[string()], indir=string()}

🔥 EXPORTS 🔥

run/2 — the main character entry point 👑

run(Doclet_gen::edoc_doclet:command(), Ctxt::edoc_doclet:context()) -> ok

Main doclet entry point. See the file edoc_doclet.hrl for the data structures used for passing parameters.

Also see edoc:layout/2 for layout-related options, and edoc:get_doc/2 for options related to reading source files.

✨ Options ✨

• {file_suffix, string()} — Specifies the suffix used for output files. The default value is ".html". Cute little output suffix behavior, no cap 💅
• {hidden, boolean()} — If the value is true, documentation of hidden modules and functions will also be included. The default value is false. So hidden stays hidden unless you say true, bestie 🙈
• {overview, edoc:filename()} — Specifies the name of the overview-file. By default, this doclet looks for a file "overview.edoc" in the target directory. It's giving overview-file energy 🎀
• {private, boolean()} — If the value is true, documentation of private modules and functions will also be included. The default value is false. Private docs stay private by default, periodt 💅
• {stylesheet, string()} — Specifies the URI used for referencing the stylesheet. The default value is "stylesheet.css". If an empty string is specified, no stylesheet reference will be generated. So empty string = no stylesheet reference, literally 💅
• {stylesheet_file, edoc:filename()} — Specifies the name of the stylesheet file. By default, this doclet uses the file "stylesheet.css" in the priv subdirectory of the EDoc installation directory. The named file will be copied to the target directory. Copying to the target directory is the vibe 🫶
• {title, string()} — Specifies the title of the overview-page. Title go brrr on the overview-page 👑

🌈 SEE ALSO 🌈

• edoc — go read that one too, bestie 💖⭐

👑 AUTHORS 👑

• Richard Carlsson — <carlsson.richard@gmail.com>

---

cute sign-off: source/version is edoc 1.2, manual is edoc_doclet(3erl), and the footer didn't list a date — no cap, that's the whole footer tea 🍓💅🫶