View Source doctest (doctest v0.9.3)

Provides functions to test docs.

Summary

Types

options/0

result/0

Functions

forms(Forms, Opts)

module(Mod)

module(Mod, Opts)

Types

options/0

-type options() ::
          #{enabled => boolean(),
            moduledoc => boolean(),
            doc => boolean() | [{atom(), arity()}],
            eunit_opts => rebar3_config | [term()],
            extractors => [module()]}.

result/0

-type result() :: ok | error.

Functions

forms(Forms, Opts)

-spec forms(Forms, Opts) -> Result
               when Forms :: [erl_syntax:syntaxTree()], Opts :: options(), Result :: result().

module(Mod)

-spec module(Mod) -> Result when Mod :: module(), Result :: result().

module(Mod, Opts)

-spec module(Mod, Opts) -> Result when Mod :: module(), Opts :: options(), Result :: result().