shell_docs
Module
Module Summary
Since
Description
This module can be used to render function and type documentation to be printed in a shell. It can only render documentation of the format application/erlang+html. For more information about this format see Documentation Storage in Erl_Docgen's User's Guide.
Data Types
The HTML tags allowed in application/erlang+html.
chunk_element_attrs() = [chunk_element_attr()]
chunk_element() =
{chunk_element_type(),
chunk_element_attrs(),
chunk_elements()} |
binary()
chunk_elements() = [chunk_element()]
Exports
| OTP 23.0 |
Render the documentation for a module.
render(Module :: module(), Function :: function(), Docs :: docs_v1()) -> unicode:chardata() | {error, function_missing} |
OTP 23.0 |
render(Module :: module(), Function :: function(), Arity :: arity(), Docs :: docs_v1()) -> unicode:chardata() | {error, function_missing} |
OTP 23.0 |
Render the documentation for a function.
| OTP 23.0 |
Render a list of all available types in a module.
render_type(Module :: module(), Type :: atom(), Docs :: docs_v1()) -> unicode:chardata() | {error, type_missing} |
OTP 23.0 |
render_type(Module :: module(), Type :: atom(), Arity :: arity(), Docs :: docs_v1()) -> unicode:chardata() | {error, type_missing} |
OTP 23.0 |
Render the documentation of a type in a module.
| OTP 23.0 |
Types
This function can be used to do a basic validation of the doc content of application/erlang+html format.
| OTP 23.0 |
This function can be used to do whitespace normalization of application/erlang+html documentation.