Scroll to navigation

edoc_doclet_chunks(3erl) Erlang Module Definition edoc_doclet_chunks(3erl)

NAME

edoc_doclet_chunks - Doclet generating standalone
EEP-48 doc chunk files.

DESCRIPTION

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.

SEE ALSO

edoc_layout_chunks, shell_docs(3erl)

AUTHORS

Radek Szymczyszyn <lavrin@gmail.com>

edoc 1.2