logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

edoc_layout_chunks - Convert EDoc module documentation to an

Authors

       Radek Szymczyszyn <lavrin@gmail.com>

                                                    edoc 1.1                            edoc_layout_chunks(3erl)

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_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.

         metadata()=map():mime_type()=binary():signature()=[binary()]:

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.

Exports

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

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

Name

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

See Also

       edoc_doclet_chunks, shell_docs(3erl)

See Also