lfe_doc(3)                                                          lfe_doc(3)



NAME
       lfe_doc - Lisp Flavoured Erlang (LFE) documentation parser.

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

       There is no guarantee the internal formats will not change but the  in‐
       terface functions should stay the same.

EXPORTS
       extract_module_docs(Mod,  CompilerInfo)  ->  {ok,ModDocs}  | {error,Er‐
       rors,[]}

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

       save_module_docs(Beam, ModDocs, CompilerInfo) -> Beam

       Add the "LDoc" chunk containing ModDocs to a module's .beam binary.

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

       Extract the documentation chunk from a module.  The chunk will be  con‐
       verted to an internal format.

       format_docs/1

       Take  a  list of doc strings and generate a list of indented doc lines.
       Each doc string is indented separately.

       format_error(ErrorDecriptor) -> Chars

       Given an ErrorDescriptor, return a deep list of  characters  which  de‐
       scribe  the  error.  This function is usually called implicitly when an
       ErrorInfo structure is processed.  See lfe_comp(3).

       N.B.  Currently, format_error/1 always returns "doc error".

   MODULE DOC ACCESSORS
       module_doc(DocChunk) -> [DocString]

       mf_docs(DocChunk) -> [MacFuncDoc]

       mf_doc_type(MacFuncDoc) -> function | macro

       function_docs(DocChunk) -> [FuncDoc]

       macro_docs(DocChunk) -> [MacDoc]

       Extract fields from the module documentation chunk.

   FUNCTION DOC ACCESSORS
       function_name(FuncDoc) -> Name

       function_arity(FuncDoc) -> Arity

       function_line(FuncDoc) -> Line

       function_patterns(FuncDoc) -> [Pattern]

       function_doc(FuncDoc) -> [DocString]

       Extract fields from a function documentation structure.

   MACRO DOC ACCESSORS
       macro_name(MacDoc) -> Name

       macro_line(MacDoc) -> Line

       macro_patterns(MacDoc) -> [Pattern]

       macro_doc(MacDoc) -> [DocString]

       Extract fields from a macro documentation structure.

SEE ALSO
       lfe_comp(3), lfe_macro(3)

AUTHORS
       Eric Bailey.



                                     2016                           lfe_doc(3)
