查看源代码 edoc_extract (edoc v1.3.2)

从注释的源代码语法树中提取 EDoc 文档。给定的 Forms 必须是 form_list 类型的单个语法树，或者表示“程序形式”的语法树列表（参见 edoc:read_source/2）。Env 是由 edoc_lib:get_doc_env/3 创建的环境。File 参数仅用于错误报告和输出文件名生成。

source(Forms, Comments, File, Env, Opts)

类似于 source/4，但首先在语法树中插入给定的注释。语法树必须包含有效的位置信息。（参见 edoc:read_comments/2。）

text(Text, Context, Env, Opts)

返回文本中的标签列表。第一个标签之前的任何文本行都将被忽略。Env 是由 edoc_lib:get_doc_env/3 创建的环境。

类型

context/0

-type context() :: module | footer | function | overview | single.

filename/0

-type filename() :: file:filename().

proplist/0

-type proplist() :: proplists:proplist().

函数

file(File, Context, Env, Opts)

-spec file(File, Context, Env, Opts) -> {ok, Tags} | {error, Reason}
              when
                  File :: filename(),
                  Context :: context(),
                  Env :: edoc:env(),
                  Opts :: proplist(),
                  Tags :: [term()],
                  Reason :: term().

有关选项，请参阅 text/4。

header(Forms, File, Env, Opts)

-spec header(Forms, File, Env, Opts) -> edoc:entry_data()
                when
                    Forms :: erl_syntax:forms(),
                    File :: filename(),
                    Env :: edoc:env(),
                    Opts :: proplist().

另请参阅：//syntax_tools/erl_recomment，header/5。

header(Forms, Comments, File, Env, Opts)

-spec header(Forms, Comments, File, Env, Opts) -> edoc:entry_data()
                when
                    Forms :: erl_syntax:forms(),
                    Comments :: [edoc:comment()],
                    File :: filename(),
                    Env :: edoc:env(),
                    Opts :: proplist().

类似于 header/4，但首先在语法树中插入给定的注释。语法树必须包含有效的位置信息。（参见 edoc:read_comments/2。）

另请参阅：//syntax_tools/erl_recomment，header/3，header/4。

source(File, Env, Opts)

-spec source(File, Env, Opts) -> R
                when
                    File :: filename(),
                    Env :: edoc:env(),
                    Opts :: proplist(),
                    R :: {module(), edoc:edoc_module()} | {module(), edoc:edoc_module(), [edoc:entry()]}.

类似于 source/5，但是从指定的文件读取语法树和注释。

另请参阅：source/4，edoc:read_comments/2，edoc:read_source/2。

source(Forms, File, Env, Opts)

-spec source(Forms, File, Env, Opts) -> R
                when
                    Forms :: erl_syntax:forms(),
                    File :: filename(),
                    Env :: edoc:env(),
                    Opts :: proplist(),
                    R :: {module(), edoc:edoc_module()} | {module(), edoc:edoc_module(), [edoc:entry()]}.

有关 def、hidden、private 和 todo 选项的描述，请参阅 edoc:get_doc/2。

另请参阅：//syntax_tools/erl_recomment，source/5，edoc:read_comments/2，edoc:read_source/2。

source(Forms, Comments, File, Env, Opts)

-spec source(Forms, Comments, File, Env, Opts) -> R
                when
                    Forms :: erl_syntax:forms(),
                    Comments :: [edoc:comment()],
                    File :: filename(),
                    Env :: edoc:env(),
                    Opts :: proplist(),
                    R :: {module(), edoc:edoc_module()} | {module(), edoc:edoc_module(), [edoc:entry()]}.

类似于 source/4，但首先在语法树中插入给定的注释。语法树必须包含有效的位置信息。（参见 edoc:read_comments/2。）

另请参阅：//syntax_tools/erl_recomment，source/3，source/4，edoc:read_comments/2，edoc:read_source/2。

text(Text, Context, Env, Opts)

-spec text(Text, Context, Env, Opts) -> Tags
              when
                  Text :: string(),
                  Context :: context(),
                  Env :: edoc:env(),
                  Opts :: proplist(),
                  Tags :: [term()].

返回文本中的标签列表。第一个标签之前的任何文本行都将被忽略。Env 是由 edoc_lib:get_doc_env/3 创建的环境。

有关 def 选项的描述，请参阅 source/4。