.TH edoc_layout_chunks 3erl "edoc 1.2.1" "" "Erlang Module Definition"
.SH NAME
edoc_layout_chunks \- Convert EDoc module documentation to an
  EEP-48
  docs_v1 chunk.
.SH DESCRIPTION
.LP
Convert EDoc module documentation to an EEP-48 \fIdocs_v1\fR\& chunk\&.
.LP
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\&.
.LP
This module breaks the convention stated in \fIedoc_doclet\fR\& to not rely on \fIedoc\&.hrl\fR\& in doclets and layouts\&. It uses \fI#entry{}\fR\& records directly to recover information that is not otherwise available to layouts\&.
.SH "DATA TYPES"

.RS 2
.TP 2
.B
beam_language() = atom():

.TP 2
.B
doc() = #{doc_language() => doc_string()} | none | hidden:

.TP 2
.B
doc_language() = binary():

.TP 2
.B
doc_string() = binary():

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

.RS 2
.LP
The Docs v1 chunk according to EEP 48\&.
.RE

.TP 2
.B
docs_v1_entry() = {_KindNameArity::{atom(), atom(), arity()}, _Anno::erl_anno:anno(), _Signature::signature(), _Doc::doc(), _Metadata::metadata()}:

.RS 2
.LP
A tuple equivalent to the \fI#docs_v1_entry{}\fR\& record, but with the record name field skipped\&.
.RE

.TP 2
.B
metadata() = map():

.TP 2
.B
mime_type() = binary():

.TP 2
.B
signature() = [binary()]:

.RE
.SH EXPORTS
.LP
.B
module(Doc::edoc:edoc_module(), Options::proplists:proplist()) -> binary()
.br
.RS
.LP
Convert EDoc module documentation to an EEP-48 style doc chunk\&.
.RE

.SH "SEE ALSO"

.LP
edoc_doclet_chunks, shell_docs(3erl)
.SH AUTHORS
.LP
Radek Szymczyszyn
.I
<lavrin@gmail\&.com>