edoc_layout_chunks(3)

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

DESCRIPTION

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.

See also: edoc_doclet_chunks, //stdlib/shell_docs.

DATA TYPES

docs_v1() :: #docs_v1{anno :: erl_anno:anno(), beam_language :: beam_language(), format :: mime_type(), module_doc :: doc(), metadata :: metadata(), docs :: [docs_v1_entry()]}.

    The Docs v1 chunk according to EEP 48.
docs_v1_entry() :: {_KindNameArity :: {atom(), atom(), arity()}, _Anno :: erl_anno:anno(), _Signature :: signature(), _Doc :: doc(), _Metadata :: metadata()}.

    A tuple equivalent to the #docs_v1_entry{} record, but with the record name field skipped.
xmerl_doc_node() :: #xmlComment{} | #xmlElement{} | #xmlPI{} | #xmlText{}.

    Subtype of xmerl_xpath:nodeEntity(). It corresponds to #xmlElement.content as defined by xmerl.hrl, sans the #xmlDecl{}.

FUNCTIONS

expand_docgen_rel(Rel) -> string() when Rel :: string().

    Rel is actually a stringified edoc_refs:docgen_rel().
module(edoc:edoc_module(), proplists:proplist()) -> binary().

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