链接到 ExDoc 中的外部类型答案

【问题标题】：Link to external types in ExDoc链接到 ExDoc 中的外部类型
【发布时间】：2016-10-07 21:02:36
【问题描述】：

我最近创建了我的第一个 Hex 包； Ecto.Rut 我现在正在处理它的文档。由于它在后面使用Ecto.Repo 并返回Ecto.Schema 和Ecto.Changeset 类型，我想在@specs 中链接它们。

Internal 和 Elixir 核心类型（例如 Keyword.t）会自动链接，但 ex_doc 不会链接 Ecto 模块中定义的外部类型。我该如何做到这一点？

我目前尝试在 @spec 中指定完整的模块名称，但这不起作用：

@callback all(opts :: Keyword.t) :: [Ecto.Schema.t] | no_return

【问题讨论】：

可能不支持。您可以在@doc 或@moduledoc 中手动写入，如下所示：github.com/phoenixframework/phoenix/blob/…
@ma2gedev 从今天开始正式支持。
@pdimitar 哇！不错！

【解决方案1】：

在some discussion on ElixirForum 之后，Jose 添加了这个功能。 ExDoc v0.14.2 及以后的版本，它支持外部依赖模块的自动链接。

通过引用来自任何依赖项的模块、函数、类型或回调，例如 MyDep，ExDoc 将自动链接到 hexdocs.pm 上的该依赖项文档（该链接可以使用 :deps 选项配置你的 mix.exs)

这意味着，只需提及完整的模块名称就会自动链接类型、回调、模块和方法。因此，通过更新到最新的 ExDoc，我现有的代码现在会自动链接：

@callback all(opts :: Keyword.t) :: [Ecto.Schema.t] | no_return

【讨论】：