如何为Ejabberd定制模块生成文档？

Question

我已经创建了一些自定义模块，我需要为所有自定义模块创建文档，所以有什么帮助吗？

Answer 1

您可以使用edoc-http://erlang.org/doc/apps/edoc/chapter.html。例如：test_edoc.erl

-module(test_edoc).

-export([run/1]).

%% -------------------------------------------------------------------
%% @doc
%% Some description
%% @end
%% -------------------------------------------------------------------
-spec run(N :: integer()) -> Result :: integer() | error.

run(N) when is_integer(N) -> N + 1;
run(_) -> error.

然后在Erlang shell中：

1> edoc:files(["test_edoc.erl"], [{dir, doc}]).
ok

然后应在运行edoc:files/2的当前文件夹中生成doc文件夹，因此，转到doc文件夹并在浏览器test_edoc.html中打开