标准库的 SBT Scaladoc 配置

Question

我想设置 ScalaDoc 以从 SBT 链接到标准库。我正在使用 0.12.4，但我很快就会切换到 0.13。此外，我想通过使用 0.13 的支持来简化设置。

最好的选择是使用0.13's autoAPIMappings 进行自动映射：

//Requires SBT 0.13. However, automatic mapping does not work for the standard library.
autoAPIMappings := true

scala-library 应该支持它，因为its pom 设置了info.apiURL 和that's what SBT reads。

但是，这不起作用。 String 和 GenTraversable 都没有超链接。 last 表示没有选项添加到 scaladoc 参数。

所以：

1. 如何修复autoAPIMappings？
2. 还有其他选择吗？
3. 我没有观察到这个功能有效，但也许我只需要另一个设置info.apiUrl 的包。想到了什么包？谷歌似乎没有什么帮助，如何查询具有某些属性的 maven 包，甚至如何在 pom 上进行全文搜索也不明显。 find ~/.m2 ~/.ivy2 -name '*.pom' -type f|xargs grep info.apiUrl 在我的 2G 本地缓存中没有发现任何结果。

（这个问题可能看起来是 SBT Scaladoc Configuration 的重复，但它是针对更新的配置和不同的 SBT 版本，所以问题是不同的；此外，现有答案显示了一个已弃用的解决方案）。

Answer 1

我不知道autoAPIMappings 的解决方案，但这里有一些替代方案。

1. 一种可能的替代方法是使用0.13's apiMappings，可以设置手动映射。在我的系统上，last doc 表明这会将-doc-external-doc:/Users/pgiarrusso/.sbt/boot/scala-2.10.2/lib/scala-library.jar#http://www.scala-lang.org/api/2.10.2/ 添加到命令行，并且可以正常工作。

   apiMappings += (scalaInstance.value.libraryJar -> url(s"http://www.scala-lang.org/api/${scalaVersion.value}/"))
   

这需要 Scaladoc 2.10.2 或更高版本。

1. 或者，可以手动添加相同的选项。这在 SBT 0.12 上是必需的。重要的主要步骤是找到合适的库。

   在 0.13 语法中：

   scalacOptions in (Compile, doc) += s"-doc-external-doc:${scalaInstance.value.libraryJar}#http://www.scala-lang.org/api/${scalaVersion.value}/"
   

   在 0.12 语法中：

   scalacOptions in (Compile, doc) <+= (scalaVersion, scalaInstance) map { (scalaVer, scalaIn) =>
     "-doc-external-doc:" + scalaIn.libraryJar + "#http://www.scala-lang.org/api/" + scalaVer + "/"}
   

   此选项仍需要 Scaladoc 2.10.2。

2. 最后，在较旧的 Scaladocs 上，可以使用 -external-urls，尽管它不太精确（因此已被弃用），如 @MarkHarrah had suggested earlier。

   在 0.13 语法中：

   scalacOptions in (Compile, doc) += s"-external-urls:scala=http://www.scala-lang.org/api/${scalaVersion.value}/"
   

   在 0.12 语法中：

   scalacOptions in (Compile, doc) <+= scalaVersion map (scalaVer => "-external-urls:scala=http://www.scala-lang.org/api/" + scalaVer + "/")
   

最后，请注意，在所有情况下，String 的出现都不会成为超链接，这可能是因为类型别名的某些错误。但是，其他类型（包括GenTraversable）是超链接的。

Answer 2

只需使用这个插件：

https://github.com/ThoughtWorksInc/sbt-api-mappings

并且外部引用将被解析。