lodox

provider

The Lodox rebar3 provider.

deps/0

The list of dependencies, providers, that need to run before this one.

desc/0

The description for the task, used by rebar3 help.

do/1

(state)

Generate documentation for each application in the project.

See: [[lodox-html-writer:write-docs/1]]

format_error/1

(reason)

When an exception is raised or a value returned as
#(error #((MODULE) reason), (format_error reason) will be called
so a string can be formatted explaining the issue.

get-lodox-opts/2

(name rebar-opts (when (is_binary name)))
(app rebar-opts (when (is_atom app)))

Parse rebar.config for Lodox options.
If name is a binary, convert it to an atom first.

init/1

(state)

Initiate the Lodox provider.

maybe-default/3

(key value opts)

Prepend `#(,key ,value) to opts iff key is not already defined.

namespace/0

The namespace in which lodox is registered, lfe.

provider-name/0

The 'user friendly' name of the task, lodox.

short-desc/0

A one line, short description of the task, used in lists of providers.

write-docs/1

(app-info)

Given an app_info_t, call [[lodox-html-writer:write-docs/1]] appropriately.