docs_v1() = #docs_v1{}
docs_v1() = #docs_v1{}
The record holding EEP-48 documentation for a module. You can use code:get_doc/1
to fetch this information from a module.
shell_docs
Functions used to render EEP-48 style documentation for a shell.
Module shell_docs was introduced in OTP 23.0.
This module can be used to render function and type documentation to be printed in a shell. This is the module that is used to render the docs accessed through the shell through c:h/1,2,3
. Example:
1> h(maps,new,0). -spec new() -> Map when Map :: #{}. Since: OTP 17.0 Returns a new empty map. Example: > maps:new(). #{}
This module formats and renders EEP-48 documentation of the format application/erlang+html
. For more information about this format see Documentation Storage
in Erl_Docgen's User's Guide. It can also render any other format of "text" type, although those will be rendered as is.
docs_v1() = #docs_v1{}
The record holding EEP-48 documentation for a module. You can use code:get_doc/1
to fetch this information from a module.
config() =
#{encoding => unicode | latin1,
columns => integer() >= 1,
ansi => boolean()}
The configuration of how the documentation should be rendered.
shell_docs
uses the value returned by
io:getopts()
.
ansi escape codes
should be used to render graphical details such as bold and underscore. By default
shell_docs
will try to determine if the receiving shell supports ansi escape codes. It is possible to override the automated check by setting the kernel configuration parameter
shell_docs_ansi
to a
boolean()
value.
shell_docs
used the value returned by
io:columns()
.
chunk_element_block_type() =
p | 'div' | br | pre | ul | ol | li | dl | dt | dd | h1 | h2 |
h3 | h4 | h5 | h6
chunk_element_inline_type() = a | code | em | strong | i | b
chunk_element_type() =
chunk_element_inline_type() | chunk_element_block_type()
The HTML tags allowed in application/erlang+html
.
chunk_element_attr() = {atom(), unicode:chardata()}
chunk_element_attrs() = [chunk_element_attr()]
chunk_element() =
{chunk_element_type(),
chunk_element_attrs(),
chunk_elements()} |
binary()
chunk_elements() = [chunk_element()]
unicode:chardata()
unicode:chardata()
Render the documentation for a module or function.
unicode:chardata()
unicode:chardata()
Render the documentation of a type in a module.
unicode:chardata()
unicode:chardata()
Render the documentation of a callback in a module.
This function can be used to do a basic validation of the doc content of application/erlang+html
format.
This function can be used to do whitespace normalization of application/erlang+html
documentation.
chunk_element_type()
]
This function can be used to find out which tags are supported by application/erlang+html
documentation.
© 2010–2022 Ericsson AB
Licensed under the Apache License, Version 2.0.