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.

random.erl

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

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

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

Answer 1

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

您可以做的是将声明包含到临时文件模块中。

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

那时您不必拥有 tempfile.hrl。

=>

临时文件.erl

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

随机数

-module(random).

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