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

用于从 Erlang 启动选项调用 EDoc 的接口。

以下是一个在 Makefile 中典型用法的示例

     docs:
             erl -noshell -run edoc_run application "'$(APP_NAME)'" \
               '"."' '[{def,{vsn,"$(VSN)"}}]'

(注意使用单引号以避免 shell 扩展，以及用双引号括起字符串）。

0.6.9 版本的新特性：不再需要在命令行末尾写 -s init stop 以使执行终止。终止（向操作系统发出成功或失败的信号）现在内置于这些函数中。

另请参阅：edoc。

摘要

类型

args/0

函数

application(Args)

使用相应的参数调用 edoc:application/3。列表中的字符串被解析为 Erlang 常量项。列表可以是 [App]、[App, Options] 或 [App, Dir, Options]。在第一种情况下，将调用 edoc:application/1；在第二种情况下，将调用 edoc:application/2。

file(Args) 已弃用

使用相应的参数调用 edoc:file/2。列表中的字符串被解析为 Erlang 常量项。列表可以是 [File] 或 [File, Options]。在第一种情况下，会将一个空选项列表传递给 edoc:file/2。

files(Args)

使用相应的参数调用 edoc:files/2。列表中的字符串被解析为 Erlang 常量项。列表可以是 [Files] 或 [Files, Options]。在第一种情况下，将调用 edoc:files/1。

类型

链接到此类型

args/0

查看源代码 
-type args() :: [string()].

函数

链接到此函数

application(Args)

查看源代码 
-spec application(args()) -> no_return().

使用相应的参数调用 edoc:application/3。列表中的字符串被解析为 Erlang 常量项。列表可以是 [App]、[App, Options] 或 [App, Dir, Options]。在第一种情况下，将调用 edoc:application/1；在第二种情况下，将调用 edoc:application/2。

函数调用永远不会返回；相反，当调用完成时，模拟器会自动终止，向操作系统发出成功或失败的信号。

链接到此函数

file(Args)

查看源代码
此函数已弃用。这是 EDoc 旧接口的一部分，主要为了向后兼容而保留。生成文档的首选方式是通过函数 application/1 和 files/1 之一。
-spec file(args()) -> no_return().

使用相应的参数调用 edoc:file/2。列表中的字符串被解析为 Erlang 常量项。列表可以是 [File] 或 [File, Options]。在第一种情况下，会将一个空选项列表传递给 edoc:file/2。

以下是一个在 Makefile 中典型用法的示例

     $(DOCDIR)/%.html:%.erl
             erl -noshell -run edoc_run file '"$<"' '[{dir,"$(DOCDIR)"}]' \
               -s init stop

函数调用永远不会返回；相反，当调用完成时，模拟器会自动终止，向操作系统发出成功或失败的信号。

链接到此函数

files(Args)

查看源代码 
-spec files(args()) -> no_return().

使用相应的参数调用 edoc:files/2。列表中的字符串被解析为 Erlang 常量项。列表可以是 [Files] 或 [Files, Options]。在第一种情况下，将调用 edoc:files/1。

函数调用永远不会返回；相反，当调用完成时，模拟器会自动终止，向操作系统发出成功或失败的信号。