erlang - edoc 没有在 hrl 文件中生成所有文档类型？

Question

我目前有三个文件：

临时文件.hrl

-export_type([temptype/0]).
-type temptype() :: string().
%% blah blah documentation

临时文件.erl

-module(tempfile).

... more code, but no references to the temptype() type.

随机的.erl

-module(random).
%% @headerfile "tempfile.hrl"
-include("tempfile.hrl").

-spec random() -> tempfile:temptype().

但是，当使用 edoc 时，不会temptype()出现任何文档。出现一个超链接tempfile.html#temptype，但它没有链接到任何地方。我什至尝试使用-export_type但没有用......可能是什么问题？谢谢。

Answer 1

temptype() 不是模块临时文件的一部分。

您可以做的是将声明包含到 tempfile 模块中。

-export_type([temptype/0]).
-type temptype() :: string().

那么你不必有一个 tempfile.hrl 。

=>

临时文件.erl

-module(tempfile).
-export_type([temptype/0]).
-type temptype() :: string().

随机的.erl

-module(random).

-spec random() -> tempfile:temptype().

Answer 2

如果您确实想将头文件分开，可以使用通用标签从 Erlang 文件中导入标签，如下所示@headerfile：

临时文件.erl

-module(tempfile).

%%% @headerfile tempfile.hrl
... more code, but no references to the temptype() type.