erlang - edoc は hrl ファイルにすべてのドキュメント タイプを生成していませんか?

Question

現在、次の 3 つのファイルがあります。

tempfile.hrl

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

tempfile.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 の一部ではありません。

できることは、宣言を tempfile モジュールに含めることです。

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

その場合、tempfile.hrl は必要ありません。

=>

tempfile.erl

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

ランダム.erl

-module(random).

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