View Source doctest (doctest v0.9.0)

Provides functions to test docs.

Summary

Types

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

Functions

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