lfe

.\" Automatically generated by Pandoc 2.11.2
.\"
.TH "lfe_docs" "3" "2016" "" ""
.hy
.SH NAME
.PP
lfe_docs - Lisp Flavoured Erlang (LFE) documentation handling.
.SH SYNOPSIS
.PP
This module provides functions to parse docstrings in LFE module sources
in EEP48 format.
.SH EXPORTS
.PP
\f[B]make_chunk(Mod, CompilerInfo) -> {ok,DocsChunk}\f[R]
.PP
Parse a module\[cq]s docstrings and return a documentation chunk.
.PP
\f[B]make_docs_info(Mod, CompilerInfo) -> {ok,DocsInfo}\f[R]
.PP
Parse a module\[cq]s docstrings and return the documentation info.
.PP
\f[B]get_module_docs(Module | Binary) -> {ok,DocsInfo} |
{error,Error}\f[R]
.PP
Extract the documentation from a module documentation chunk and return
it in the documentation format of the current Erlang version.
.SH SEE ALSO
.PP
\f[B]lfe_comp(3)\f[R], \f[B]lfe_macro(3)\f[R]
.SH AUTHORS
Robert Virding.