プロジェクトにJavaソースのみがある場合、sbtはjavadoc
を実行します。Scalaソースがある場合、sbtはscaladoc
を実行します。(これは、scaladoc
がJavaソースのJavadocコメントを処理したり、Javadocにリンクしたりしないことに起因します。)
scaladoc
を構成するには、doc
タスクにscalacOptions
をスコープします。compile
のオプションに追加せずにオプションを決定的に設定するには、:=
を使用します。メインソースの場合はCompile
に、テストソースの場合はTest
にスコープします。例:
Compile / doc / scalacOptions := Seq("-groups", "-implicits")
scaladoc
を構成するには、doc
タスクにscalacOptions
をスコープします。ベースオプションにオプションを追加するには、+=
または++=
を使用します。単一のオプションを追加するには、+=
を使用します。Seq[String]
を追加するには、++=
を使用します。メインソースの場合はCompile
に、テストソースの場合はTest
にスコープします。例:
Compile / doc / scalacOptions ++= Seq("-groups", "-implicits")
javadoc
を構成するには、doc
タスクにjavacOptions
をスコープします。compile
のオプションに追加せずにオプションを決定的に設定するには、:=
を使用します。メインソースの場合はCompile
に、テストソースの場合はTest
にスコープします。
javadoc
を構成するには、doc
タスクにjavacOptions
をスコープします。ベースオプションにオプションを追加するには、+=
または++=
を使用します。単一のオプションを追加するには、+=
を使用します。Seq[String]
を追加するには、++=
を使用します。メインソースの場合はCompile
に、テストソースの場合はTest
にスコープします。例:
Compile / doc / javacOptions ++= Seq("-notimestamp", "-linksource")
管理された依存関係のAPIドキュメントをどこで探せるかをscaladoc
に伝えるには、autoAPIMappings := true
を設定します。これには、依存関係がそのメタデータにこの情報を持っており、Scala 2.10.2以降でscaladoc
を使用している必要があります。
依存関係のAPIドキュメントをどこで探せるかをscaladoc
に手動で伝えるには、apiMappings
に(File, URL)
型のマッピングを追加します。(これにはScala 2.10.2以降のscaladoc
が必要です。)これらのマッピングはautoAPIMappings
に加えて使用されるため、この手動構成は通常、管理されていない依存関係に対して行われます。File
キーは、クラスパスに渡された依存関係の場所です。URL
値は、依存関係のAPIドキュメントのベースURLです。例:
apiMappings += (
(unmanagedBase.value / "a-library.jar") ->
url("https://example.org/api/")
)
ライブラリのScaladocのベースURL
を定義するには、apiURL
を設定します。これにより、ライブラリのクライアントはautoAPIMappings
を使用してAPIドキュメントに自動的にリンクできるようになります。(これはScala 2.10.2以降でのみ機能します。)例:
apiURL := Some(url("https://example.org/api/"))
この情報は、公開されたpom.xml
のプロパティに含まれ、sbtによって自動的に消費される可能性があります。