View Source doctest_extract behaviour (doctest v0.10.2)

Summary

Types

chunk/0

-type chunk() :: {token(), Ln :: pos_integer(), Doc :: binary()}.

code_blocks/0

-type code_blocks() :: [{binary(), location()}] | none.

doc_token/0

-type doc_token() :: {doc, mfa(), Tag :: binary()}.

location/0

-type location() :: {Ln :: pos_integer(), Col :: pos_integer()}.

moduledoc_token/0

-type moduledoc_token() :: {moduledoc, module(), Tag :: binary()}.

token/0

-type token() :: doc_token() | moduledoc_token().

Callbacks

chunks/1

-callback chunks(Args) -> Chunks
                    when
                        Args :: {Mod, Forms},
                        Mod :: module(),
                        Forms :: [erl_syntax:syntaxTree()],
                        Chunks :: [chunk()].

code_blocks/1

-callback code_blocks(Doc) -> CodeBlocks when Doc :: binary(), CodeBlocks :: code_blocks().

Functions

code_blocks(Doc, RE)

default_extractors()

forms_tests(Forms, Opts)

module_forms(Mod)

module_tests(Mod, Opts)