1. APIドキュメントの生成

APIドキュメントの生成 

javadocまたはscaladocの選択 

プロジェクトにJavaソースのみがある場合、sbtはjavadocを実行します。Scalaソースがある場合、sbtはscaladocを実行します。(これは、scaladocがJavaソースのJavadocコメントを処理したり、Javadocにリンクしたりしないことに起因します。)

コンパイルとは独立してscaladocの生成に使用されるオプションを設定する 

scaladocを構成するには、docタスクにscalacOptionsをスコープします。compileのオプションに追加せずにオプションを決定的に設定するには、:=を使用します。メインソースの場合はCompileに、テストソースの場合はTestにスコープします。例:

Compile / doc / scalacOptions := Seq("-groups", "-implicits")

scaladocのオプションをコンパイルオプションに追加する 

scaladocを構成するには、docタスクにscalacOptionsをスコープします。ベースオプションにオプションを追加するには、+=または++=を使用します。単一のオプションを追加するには、+=を使用します。Seq[String]を追加するには、++=を使用します。メインソースの場合はCompileに、テストソースの場合はTestにスコープします。例:

Compile / doc / scalacOptions ++= Seq("-groups", "-implicits")

コンパイルとは独立してjavadocの生成に使用されるオプションを設定する 

javadocを構成するには、docタスクにjavacOptionsをスコープします。compileのオプションに追加せずにオプションを決定的に設定するには、:=を使用します。メインソースの場合はCompileに、テストソースの場合はTestにスコープします。

javadocのオプションをコンパイルオプションに追加する 

javadocを構成するには、docタスクにjavacOptionsをスコープします。ベースオプションにオプションを追加するには、+=または++=を使用します。単一のオプションを追加するには、+=を使用します。Seq[String]を追加するには、++=を使用します。メインソースの場合はCompileに、テストソースの場合はTestにスコープします。例:

Compile / doc / javacOptions ++= Seq("-notimestamp", "-linksource")

管理された依存関係の外部Scaladocへの自動リンクを有効にする 

管理された依存関係のAPIドキュメントをどこで探せるかをscaladocに伝えるには、autoAPIMappings := trueを設定します。これには、依存関係がそのメタデータにこの情報を持っており、Scala 2.10.2以降でscaladocを使用している必要があります。

管理された依存関係の外部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/")
)

ライブラリのAPIドキュメントの場所を定義する 

ライブラリのScaladocのベースURLを定義するには、apiURLを設定します。これにより、ライブラリのクライアントはautoAPIMappingsを使用してAPIドキュメントに自動的にリンクできるようになります。(これはScala 2.10.2以降でのみ機能します。)例:

apiURL := Some(url("https://example.org/api/"))

この情報は、公開されたpom.xmlのプロパティに含まれ、sbtによって自動的に消費される可能性があります。