edoc_layout(3erl)

🌸 NAME 🌸

okay so bestie, this is edoc_layout — a manual page in the 3erl set, and the vibe is Erlang Module Definition ✨

edoc_layout - The standard HTML layout module for EDoc.

✨ DESCRIPTION ✨

This is the standard HTML layout module for EDoc, periodt 💅 For the tea on how to actually use it, see the edoc module — it's giving “read the docs, bestie” 🫶

💖 EXPORTS 💖

module(Element, Options) -> term()

The layout function. Options to the standard layout:

• {index_columns, integer()} — specifies the number of column pairs used for the function index tables. The default value is 1.
• {pretty_printer, atom()} — specifies how types and specifications are pretty printed. If the value erl_pp is specified the Erlang pretty printer (the module erl_pp) will be used. The default is to do no pretty printing which implies that lines can be very long 😭
• {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.
• {sort_functions, boolean()} — if true, the detailed function descriptions are listed by name, otherwise they are listed in the order of occurrence in the source file. The default value is true.
• {xml_export, Module::atom()} — specifies an xmerl callback module to be used for exporting the documentation. See xmerl:export_simple/3 for details.

See also: edoc:layout/2.

overview(E, Options) -> term()

that's the whole entry, bestie — short and iconic ✨

type(E) -> term()

also just vibing here with no extra description 🫶

🦋 SEE ALSO 🦋

• edoc

🎀 AUTHORS 🎀

Richard Carlsson <carlsson.richard@gmail.com>

---

sign-off time, bestie 🫶 source/version: edoc 1.2; page: edoc_layout(3erl); date: the footer we got doesn't show one, so we're not inventing one 💅 mwah!