edoc_doclet_chunks(3erl)

edoc_doclet_chunks3erl

Doclet generating standalone eep-48 doc chunk files.

Overview

Doclet generating standalone EEP-48 doc chunk files.

Section Using the EDoc API in the EDoc User's Guide shows an example of using this module.

Exports

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

Main doclet entry point.

This doclet is tightly coupled with edoc_layout_chunks and should be used together with it.

The only option this doclet accepts is dir, which controls where the chunks subdirectory and the EEP-48 chunk files will be placed.

Authors

Radek Szymczyszyn <[email protected]>

From erlang-manpages 1:25.2.3+dfsg-1+deb12u4 in Debian 12 (Bookworm). Parsed by carta from the page's man source.