Application

Topics

Modules

Exports

lodox-parse

Parsing LFE source files for metadata.

docs/1

(app-name)

Equivalent to [[docs/2]] with the empty list as excluded-modules.

view source

docs/2

(app-name opts)

Given an app-name (binary), return a proplist like:

[#(name        #"lodox")
 #(version     "0.16.2")
 #(description "The LFE rebar3 Lodox plugin")
 #(documents   [])
 #(modules     {{list of proplists of module metadata}})
 #(documented  {{ see documented/1 }})]
view source

documented/1

(modules)

Given a list of parsed modules, return a proplist representing
undocumented functions therein.

[#(percentage   {{float 0.0-100.0}}
 #(undocumented [#({{ module name (atom) }}
                   ["{{function/arity}}" ...]),...]))]
view source