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

ScalaDocOptions

open class ScalaDocOptions : AbstractOptions

Options for the ScalaDoc tool.

Constructors

ScalaDocOptions()

Options for the ScalaDoc tool.

Functions

getAdditionalParameters	`open fun getAdditionalParameters(): MutableList<String>` Returns the additional parameters passed to the compiler. Each parameter starts with '-'.
getBottom	`open fun getBottom(): String` Returns the HTML text to appear in the bottom text for each page.
getDocTitle	`open fun getDocTitle(): String` Returns the HTML text to appear in the main frame title.
getFooter	`open fun getFooter(): String` Returns the HTML text to appear in the footer for each page.
getHeader	`open fun getHeader(): String` Returns the HTML text to appear in the header for each page.
getStyleSheet	`open fun getStyleSheet(): File` Returns the style sheet to override default style.
getTop	`open fun getTop(): String` Returns the HTML text to appear in the top text for each page.
getWindowTitle	`open fun getWindowTitle(): String` Returns the text to appear in the window title.
isDeprecation	`open fun isDeprecation(): Boolean` Tells whether to generate deprecation information.
isUnchecked	`open fun isUnchecked(): Boolean` Tells whether to generate unchecked information.
setAdditionalParameters	`open fun setAdditionalParameters(additionalParameters: MutableList<String>): Unit` Sets the additional parameters passed to the compiler. Each parameter must start with '-'.
setBottom	`open fun setBottom(bottom: String): Unit` Sets the HTML text to appear in the bottom text for each page.
setDeprecation	`open fun setDeprecation(deprecation: Boolean): Unit` Sets whether to generate deprecation information.
setDocTitle	`open fun setDocTitle(docTitle: String): Unit` Sets the HTML text to appear in the main frame title.
setFooter	`open fun setFooter(footer: String): Unit` Sets the HTML text to appear in the footer for each page.
setHeader	`open fun setHeader(header: String): Unit` Sets the HTML text to appear in the header for each page.
setStyleSheet	`open fun setStyleSheet(styleSheet: File): Unit` Sets the style sheet to override default style.
setTop	`open fun setTop(top: String): Unit` Sets the HTML text to appear in the top text for each page.
setUnchecked	`open fun setUnchecked(unchecked: Boolean): Unit` Sets whether to generate unchecked information.
setWindowTitle	`open fun setWindowTitle(windowTitle: String): Unit` Sets the text to appear in the window title.

Inherited Functions

define	`open fun define(args: MutableMap<String, Any>): Unit`
optionMap	`open fun optionMap(): MutableMap<String, Any>`