View Source edoc_doclet_chunks (edoc v1.3.2)

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.

See also: edoc_layout_chunks, //stdlib/shell_docs.

Summary

Functions

run(Doclet_gen, Ctxt)

Main doclet entry point.

Functions

Link to this function

run(Doclet_gen, Ctxt)

View Source 
-spec run(edoc_doclet:command(), 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.