For AI agents: the documentation index is at https://docs.gradle.org/llms.txt. Request any page with the header Accept: text/markdown to get Markdown. User manual pages are also available as Markdown by replacing .html with .md in the URL.

gradle/org.gradle.api.tasks.scala/ScalaDocOptions

ScalaDocOptions

abstract class ScalaDocOptions : Serializable(source)

Options for the ScalaDoc tool.

Since

0.8

Constructors

ScalaDocOptions

constructor()

Properties

additionalParameters

@get:Nullable

@get:Input

open var additionalParameters: List<String>

@get:Nullable

@get:Input

open var bottom: String

@get:Nullable

@get:Input

open var docTitle: String

@get:Nullable

@get:Input

open var footer: String

@get:Nullable

@get:Input

open var header: String

@get:Nullable

@get:Input

open var top: String

@get:Nullable

@get:Input

open var windowTitle: String

Functions

open fun isDeprecation(): Boolean

Tells whether to generate deprecation information.

open fun isUnchecked(): Boolean

Tells whether to generate unchecked information.

open fun setDeprecation(deprecation: Boolean)

Sets whether to generate deprecation information.

open fun setUnchecked(unchecked: Boolean)

Sets whether to generate unchecked information.