1edoc_layout_chunks(3)      Erlang Module Definition      edoc_layout_chunks(3)
2
3
4

NAME

6       edoc_layout_chunks - Convert EDoc module documentation to an
7         EEP-48
8         docs_v1 chunk.
9

DESCRIPTION

11       Convert EDoc module documentation to an EEP-48 docs_v1 chunk.
12
13       This  layout  is only expected to work with edoc_doclet_chunks. Section
14       Using the EDoc API in the EDoc User's Guide shows an example  of  using
15       this module.
16
17       This  module breaks the convention stated in edoc_doclet to not rely on
18       edoc.hrl in doclets and layouts. It uses #entry{} records  directly  to
19       recover information that is not otherwise available to layouts.
20

DATA TYPES

22         beam_language() = atom():
23
24
25         doc() = #{doc_language() => doc_string()} | none | hidden:
26
27
28         doc_language() = binary():
29
30
31         doc_string() = binary():
32
33
34         docs_v1()  =  #docs_v1{anno=erl_anno:anno(),  beam_language=beam_lan‐
35         guage(), format=mime_type(),  module_doc=doc(),  metadata=metadata(),
36         docs=[docs_v1_entry()]}:
37
38
39           The Docs v1 chunk according to EEP 48.
40
41         docs_v1_entry()   =   {_KindNameArity::{atom(),   atom(),   arity()},
42         _Anno::erl_anno:anno(), _Signature::signature(), _Doc::doc(),  _Meta‐
43         data::metadata()}:
44
45
46           A  tuple  equivalent  to  the #docs_v1_entry{} record, but with the
47           record name field skipped.
48
49         metadata() = map():
50
51
52         mime_type() = binary():
53
54
55         signature() = [binary()]:
56
57

EXPORTS

59       module(Doc::edoc:edoc_module(), Options::proplists:proplist())  ->  bi‐
60       nary()
61
62              Convert EDoc module documentation to an EEP-48 style doc chunk.
63

SEE ALSO

65       edoc_doclet_chunks, shell_docs(3)
66

AUTHORS

68       Radek Szymczyszyn <lavrin@gmail.com>
69
70
71
72                                  edoc 1.0.1             edoc_layout_chunks(3)