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.

setAdditionalParameters

open fun setAdditionalParameters(@Nullable additionalParameters: @Nullable List<String>)

Sets the additional parameters passed to the compiler.

setBottom

open fun setBottom(@Nullable bottom: @Nullable String)

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

setDeprecation

open fun setDeprecation(deprecation: Boolean)

Sets whether to generate deprecation information.

setDocTitle

open fun setDocTitle(@Nullable docTitle: @Nullable String)

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

setFooter

open fun setFooter(@Nullable footer: @Nullable String)

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

setHeader

open fun setHeader(@Nullable header: @Nullable String)

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

setTop

open fun setTop(@Nullable top: @Nullable String)

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

setUnchecked

open fun setUnchecked(unchecked: Boolean)

Sets whether to generate unchecked information.

setWindowTitle

open fun setWindowTitle(@Nullable windowTitle: @Nullable String)

Sets the text to appear in the window title.