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

ScalaDocOptions

abstract class ScalaDocOptions : Serializable(source)

Options for the ScalaDoc tool.

Constructors

ScalaDocOptions

@Inject

constructor()

Functions

getAdditionalParameters

@Optional

@Input

abstract fun getAdditionalParameters(): ListProperty<String>

Returns the additional parameters passed to the compiler.

getBottom

@Optional

@Input

abstract fun getBottom(): Property<String>

Returns the HTML text to appear in the bottom text for each page.

getDeprecation

@Input

abstract fun getDeprecation(): Property<Boolean>

Tells whether to generate deprecation information.

getDocTitle

@Optional

@Input

abstract fun getDocTitle(): Property<String>

Returns the HTML text to appear in the main frame title.

getFooter

@Optional

@Input

abstract fun getFooter(): Property<String>

Returns the HTML text to appear in the footer for each page.

getHeader

@Optional

@Input

abstract fun getHeader(): Property<String>

Returns the HTML text to appear in the header for each page.

getIsDeprecation

@Internal

open fun getIsDeprecation(): Property<Boolean>

getIsUnchecked

@Internal

open fun getIsUnchecked(): Property<Boolean>

getTop

@Optional

@Input

abstract fun getTop(): Property<String>

Returns the HTML text to appear in the top text for each page.

getUnchecked

@Input

abstract fun getUnchecked(): Property<Boolean>

Tells whether to generate unchecked information.

getWindowTitle

@Optional

@Input

abstract fun getWindowTitle(): Property<String>

Returns the text to appear in the window title.