GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
lfe_doc(3) lfe_doc(3)

lfe_doc - Lisp Flavoured Erlang (LFE) documentation parser.

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

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

extract_module_docs(Mod, CompilerInfo) -> {ok,ModDocs} | {error,Errors,[]}

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 converted 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 describe 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(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_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_name(MacDoc) -> Name

macro_line(MacDoc) -> Line

macro_patterns(MacDoc) -> [Pattern]

macro_doc(MacDoc) -> [DocString]

Extract fields from a macro documentation structure.

lfe_comp(3), lfe_macro(3)

Eric Bailey.
2016

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.