---
name: "edoc_layout_chunks"
section: "3erl"
platform: "linux"
package: "erlang-manpages"
version: "1:25.2.3+dfsg-1+deb12u4"
release: "Debian 12 (Bookworm)"
platforms: ["linux"]
url: "https://new.carta.tech/edoc_layout_chunks"
---

# edoc\_layout\_chunks(3erl)

Convert EDoc module documentation to an EEP-48 docs\_v1 chunk.

## 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\_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()\]:**

  ## 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(3erl)](/shell_docs/3erl.md)

## AUTHORS

Radek Szymczyszyn *\<lavrin@gmail.com\>*