Module lfe_doc

extract_module_docs(Defs) -> any()

extract_module_docs(Defs, Cinfo) -> {ok, Docs} | {error, Errors, []}

• Defs = [{Form, Line}]
• Form = [term()]
• Line = non_neg_integer()
• Cinfo = #cinfo{}
• Docs = [doc()]
• Errors = [{error, Line, Error}, ...]
• Error = any()

format_docs(Ds) -> any()

format_error(X1) -> any()

function_arity(Doc) -> any()

function_doc(Doc) -> any()

function_docs(Fun, Ar, Lfe_docs_v1) -> any()

function_line(Doc) -> any()

function_name(Doc) -> any()

function_patterns(Doc) -> any()

get_module_docs(Mod) -> any()

macro_doc(Doc) -> any()

macro_docs(Mac, Lfe_docs_v1) -> any()

macro_line(Doc) -> any()

macro_name(Doc) -> any()

macro_patterns(Doc) -> any()

mf_doc_type(Doc) -> any()

mf_docs(Lfe_docs_v1) -> any()

module_doc(Lfe_docs_v1) -> any()

save_module_docs(Beam, Docs, Cinfo) -> {ok, Beam} | {error, Errors}

• Beam = binary()
• Docs = {[doc()], [doc()]}
• Cinfo = #cinfo{}
• Errors = [{term(), term(), term()}]