Scroll to navigation

edoc_layout_chunks(3erl) Erlang Module Definition edoc_layout_chunks(3erl)

NAME

edoc_layout_chunks - Convert EDoc module documentation to an
EEP-48
docs_v1 chunk.

DESCRIPTION

Convert EDoc module documentation to an EEP-48 docs_v1 chunk.

This layout is only expected to work with edoc_doclet_chunks. Section Using the EDoc API in the EDoc User's Guide shows an example of using this module.

This module breaks the convention stated in edoc_doclet to not rely on edoc.hrl in doclets and layouts. It uses #entry{} records directly to recover information that is not otherwise available to layouts.

DATA TYPES

EXPORTS

module(Doc::edoc:edoc_module(), Options::proplists:proplist()) -> binary()

Convert EDoc module documentation to an EEP-48 style doc chunk.

SEE ALSO

edoc_doclet_chunks, shell_docs(3erl)

AUTHORS

Radek Szymczyszyn <lavrin@gmail.com>

edoc 1.2