如果專案中只有 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 或更高版本的 scaladoc
。
將 (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
以定義函式庫的 Scaladoc 的基本 URL
。這將使函式庫的客戶端能夠使用 autoAPIMappings
自動連結到 API 文件。(這僅適用於 Scala 2.10.2 和更高版本。)例如,
apiURL := Some(url("https://example.org/api/"))
此資訊將包含在發佈的 pom.xml
的屬性中,sbt 可以自動使用它。