rebar3_erlalign_docs_prv (erlalign v0.1.6)

View Source

rebar3 provider for ErlAlign documentation converter.

Converts EDoc @doc blocks to OTP-27 -doc attributes in Erlang source files.

Usage: rebar3 edoc-to-doc [options] [files]

Options: --line-length N Line wrap width (default: 80) --keep-separators Preserve %%---- separator lines --check Check mode - fail if files would change --dry-run Show changes without modifying files -s, --silent Suppress output -h, --help Show help message

Examples: rebar3 edoc-to-doc # Convert all Erlang files rebar3 edoc-to-doc --line-length 100 # Custom line length rebar3 edoc-to-doc --keep-separators # Keep separator lines rebar3 edoc-to-doc --dry-run src/

Summary

Functions

do(State)
format_error(Reason)
init(State)
provider()

Functions

do(State)

-spec do(rebar_state:t()) -> {ok, rebar_state:t()} | {error, string()}.

format_error(Reason)

-spec format_error(any()) -> iolist().

init(State)

-spec init(rebar_state:t()) -> {ok, rebar_state:t()}.

provider()

-spec provider() -> {atom(), list()}.