# 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.