# ScalaDocOptions

abstract class ScalaDocOptions : Serializable(source)

Options for the ScalaDoc tool.

## Constructors

ScalaDocOptions
Link copied to clipboard
@Inject
constructor()

## Functions

getAdditionalParameters
Link copied to clipboard
@Optional
@Input
abstract fun getAdditionalParameters(): ListProperty<String>
Returns the additional parameters passed to the compiler.
getBottom
Link copied to clipboard
@Optional
@Input
abstract fun getBottom(): Property<String>
Returns the HTML text to appear in the bottom text for each page.
getDeprecation
Link copied to clipboard
@Input
abstract fun getDeprecation(): Property<Boolean>
Tells whether to generate deprecation information.
getDocTitle
Link copied to clipboard
@Optional
@Input
abstract fun getDocTitle(): Property<String>
Returns the HTML text to appear in the main frame title.
getFooter
Link copied to clipboard
@Optional
@Input
abstract fun getFooter(): Property<String>
Returns the HTML text to appear in the footer for each page.
getHeader
Link copied to clipboard
@Optional
@Input
abstract fun getHeader(): Property<String>
Returns the HTML text to appear in the header for each page.
getIsDeprecation
Link copied to clipboard
@Internal
open fun getIsDeprecation(): Property<Boolean>
getIsUnchecked
Link copied to clipboard
@Internal
open fun getIsUnchecked(): Property<Boolean>
getTop
Link copied to clipboard
@Optional
@Input
abstract fun getTop(): Property<String>
Returns the HTML text to appear in the top text for each page.
getUnchecked
Link copied to clipboard
@Input
abstract fun getUnchecked(): Property<Boolean>
Tells whether to generate unchecked information.
getWindowTitle
Link copied to clipboard
@Optional
@Input
abstract fun getWindowTitle(): Property<String>
Returns the text to appear in the window title.
setAdditionalParameters
Link copied to clipboard
open fun setAdditionalParameters(@Nullable additionalParameters: @Nullable List<String>)
Sets the additional parameters passed to the compiler.
setBottom
Link copied to clipboard
open fun setBottom(@Nullable bottom: @Nullable String)
Sets the HTML text to appear in the bottom text for each page.
setDeprecation
Link copied to clipboard
open fun setDeprecation(deprecation: Boolean)
Sets whether to generate deprecation information.
setDocTitle
Link copied to clipboard
open fun setDocTitle(@Nullable docTitle: @Nullable String)
Sets the HTML text to appear in the main frame title.
setFooter
Link copied to clipboard
open fun setFooter(@Nullable footer: @Nullable String)
Sets the HTML text to appear in the footer for each page.
setHeader
Link copied to clipboard
open fun setHeader(@Nullable header: @Nullable String)
Sets the HTML text to appear in the header for each page.
setTop
Link copied to clipboard
open fun setTop(@Nullable top: @Nullable String)
Sets the HTML text to appear in the top text for each page.
setUnchecked
Link copied to clipboard
open fun setUnchecked(unchecked: Boolean)
Sets whether to generate unchecked information.
setWindowTitle
Link copied to clipboard
open fun setWindowTitle(@Nullable windowTitle: @Nullable String)
Sets the text to appear in the window title.