edoc_layout_chunks - Convert EDoc module documentation to an EEP-48 docs_v1 chunk.
Please see following description for synopsis
edoc_layout_chunks(3) Erlang Module Definition edoc_layout_chunks(3)
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
beam_language() = atom():
doc() = #{doc_language() => doc_string()} | none | hidden:
doc_language() = binary():
doc_string() = binary():
docs_v1() = #docs_v1{anno=erl_anno:anno(), beam_language=beam_lan-
guage(), 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(), _Meta-
data::metadata()}:
A tuple equivalent to the #docs_v1_entry{} record, but with the
record name field skipped.
metadata() = map():
mime_type() = binary():
signature() = [binary()]:
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(3)
AUTHORS
Radek Szymczyszyn <lavrin@gmail.com>
edoc 1.1 edoc_layout_chunks(3)