查看源码 edoc_lib (edoc v1.3.2)

EDoc 的实用函数。

另请参阅：edoc。

摘要

类型

err/0

filename/0

line/0

proplist/0

函数

get_doc_env(App, Modules, Options)

创建一个由 EDoc 部分用于生成引用等的环境数据结构。有关选项 file_suffix、app_default 和 doc_path 的描述，请参阅 edoc:run/2。

infer_module_app(Mod)

推断包含给定模块的应用程序。

write_file(Text, Dir, Name, Options)

类型

err/0

-type err() :: eof | {missing, char()} | {line(), atom(), string()} | string().

filename/0

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

line/0

-type line() :: erl_anno:line().

proplist/0

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

函数

get_doc_env(App, Modules, Options)

-spec get_doc_env(App, Modules, Options) -> edoc:env()
                     when App :: atom() | no_app, Modules :: [module()], Options :: proplist().

创建一个由 EDoc 部分用于生成引用等的环境数据结构。有关选项 file_suffix、app_default 和 doc_path 的描述，请参阅 edoc:run/2。

另请参阅：edoc:get_doc/3，edoc_extract:source/4。

infer_module_app(Mod)

-spec infer_module_app(module()) -> no_app | {app, atom()}.

推断包含给定模块的应用程序。

预计未预加载且不匹配 <app>/ebin/<mod>.beam 路径模式的模块将无法正确推断出应用程序名称。在这种情况下会返回 no_app。

write_file(Text, Dir, Name, Options)