如果项目中只有 Java 源代码,sbt 将运行 javadoc
。如果有任何 Scala 源代码,sbt 将运行 scaladoc
。(这种情况是由于 scaladoc
不会处理 Java 源代码中的 Javadoc 注释,也不会链接到 Javadoc。)
将 scalacOptions
范围限定到 doc
任务以配置 scaladoc
。使用 :=
来明确设置选项,而不追加到 compile
的选项。将范围限定到 Compile
用于主源代码,或将范围限定到 Test
用于测试源代码。例如,
Compile / doc / scalacOptions := Seq("-groups", "-implicits")
将 scalacOptions
范围限定到 doc
任务以配置 scaladoc
。使用 +=
或 ++=
将选项追加到基本选项。要追加单个选项,请使用 +=
。要追加 Seq[String]
,请使用 ++=
。将范围限定到 Compile
用于主源代码,或将范围限定到 Test
用于测试源代码。例如,
Compile / doc / scalacOptions ++= Seq("-groups", "-implicits")
将 javacOptions
范围限定到 doc
任务以配置 javadoc
。使用 :=
来明确设置选项,而不追加到 compile
的选项。将范围限定到 Compile
用于主源代码,或将范围限定到 Test
用于测试源代码。
将 javacOptions
范围限定到 doc
任务以配置 javadoc
。使用 +=
或 ++=
将选项追加到基本选项。要追加单个选项,请使用 +=
。要追加 Seq[String]
,请使用 ++=
。将范围限定到 Compile
用于主源代码,或将范围限定到 Test
用于测试源代码。例如,
Compile / doc / javacOptions ++= Seq("-notimestamp", "-linksource")
设置 autoAPIMappings := true
以让 sbt 告诉 scaladoc
在哪里可以找到托管依赖项的 API 文档。这要求依赖项在其元数据中包含此信息,并且您使用的是 Scala 2.10.2 或更高版本。
将类型为 (File, URL)
的映射添加到 apiMappings
以手动告诉 scaladoc
在哪里可以找到依赖项的 API 文档。(这要求使用 Scala 2.10.2 或更高版本的 scaladoc
。)这些映射是在 autoAPIMappings
之外使用的,因此这种手动配置通常用于非托管依赖项。File
键是传递到类路径的依赖项的位置。URL
值是依赖项的 API 文档的基本 URL。例如,
apiMappings += (
(unmanagedBase.value / "a-library.jar") ->
url("https://example.org/api/")
)
设置 apiURL
以定义库的 Scaladocs 的基本 URL
。这将使您的库的客户端能够使用 autoAPIMappings
自动链接到 API 文档。(这仅适用于 Scala 2.10.2 及更高版本。)例如,
apiURL := Some(url("https://example.org/api/"))
此信息将被包含在已发布 pom.xml
的属性中,在那里它可以被 sbt 自动使用。