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

【问题标题】：How to generate document for Ejabberd custom modules?如何为 Ejabberd 自定义模块生成文档？
【发布时间】：2019-12-25 07:51:04
【问题描述】：

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

【问题讨论】：

打开一个文本文件并编写文档，对吧？
不，我要求任何文档生成器
使用 Erlang doc 或简单的 Edoc。

标签： erlang ejabberd erlang-otp ejabberd-module

【解决方案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

【讨论】：