View Source doctest_extract behaviour (doctest v0.9.0)

Summary

Types

-type chunk() :: {token(), Ln :: pos_integer(), Doc :: binary()}.
-type code_blocks() :: [{binary(), location()}] | none.
-type doc_token() :: {doc, mfa(), Tag :: binary()}.
-type location() :: {Ln :: pos_integer(), Col :: pos_integer()}.
-type moduledoc_token() :: {moduledoc, module(), Tag :: binary()}.
-type token() :: doc_token() | moduledoc_token().

Callbacks

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

Functions