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

ScalaDocOptions

abstract class ScalaDocOptions : AbstractOptions(source)

Options for the ScalaDoc tool.

Constructors

ScalaDocOptions

constructor()

Properties

additionalParameters

@get:Nullable

@get:Optional

@get:Input

open var additionalParameters: List<String>

bottom

@get:Nullable

@get:Optional

@get:Input

open var bottom: String

docTitle

@get:Nullable

@get:Optional

@get:Input

open var docTitle: String

footer

@get:Nullable

@get:Optional

@get:Input

open var footer: String

header

@get:Nullable

@get:Optional

@get:Input

open var header: String

top

@get:Nullable

@get:Optional

@get:Input

open var top: String

windowTitle

@get:Nullable

@get:Optional

@get:Input

open var windowTitle: String

Functions

define

open fun define(args: Map<String, Any>)

define

inline fun AbstractOptions.define(vararg args: Pair<String, Any?>)

Kotlin extension function for org.gradle.api.tasks.compile.AbstractOptions.define.

isDeprecation

@Input

open fun isDeprecation(): Boolean

Tells whether to generate deprecation information.

isUnchecked

@Input

open fun isUnchecked(): Boolean

Tells whether to generate unchecked information.

setDeprecation

open fun setDeprecation(deprecation: Boolean)

Sets whether to generate deprecation information.

setUnchecked

open fun setUnchecked(unchecked: Boolean)

Sets whether to generate unchecked information.