Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help 
lfe_docs(3)							     lfe_docs(3)

NAME
     lfe_docs - Lisp Flavoured Erlang (LFE) documentation handling.

SYNOPSIS
     This module provides functions to parse docstrings in LFE module sources in
     EEP48 format.

EXPORTS
     make_chunk(Mod, CompilerInfo) -> {ok,DocsChunk}

     Parse a module's docstrings and return a documentation chunk.

     make_docs_info(Mod, CompilerInfo) -> {ok,DocsInfo}

     Parse a module's docstrings and return the documentation info.

     get_module_docs(Module | Binary) -> {ok,DocsInfo} | {error,Error}

     Extract  the  documentation from a module documentation chunk and return it
     in the documentation format of the current Erlang version.

SEE ALSO
     lfe_comp(3), lfe_macro(3)

AUTHORS
     Robert Virding.

				      2016			     lfe_docs(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=lfe_docs&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help