Package org.gradle.api.tasks.scala
Class ScalaDocOptions
java.lang.Object
org.gradle.api.tasks.compile.AbstractOptions
org.gradle.api.tasks.scala.ScalaDocOptions
- All Implemented Interfaces:
Serializable
Options for the ScalaDoc tool.
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionReturns the additional parameters passed to the compiler.protected String
getAntPropertyName
(String fieldName) protected Object
getAntPropertyValue
(String fieldName, Object value) Returns the HTML text to appear in the bottom text for each page.Returns the HTML text to appear in the main frame title.Returns the HTML text to appear in the footer for each page.Returns the HTML text to appear in the header for each page.Deprecated.Scaladoc does not support to set a stylesheet any more (Scala 2.11).getTop()
Returns the HTML text to appear in the top text for each page.Returns the text to appear in the window title.boolean
Tells whether to generate deprecation information.boolean
Tells whether to generate unchecked information.void
setAdditionalParameters
(List<String> additionalParameters) Sets the additional parameters passed to the compiler.void
Sets the HTML text to appear in the bottom text for each page.void
setDeprecation
(boolean deprecation) Sets whether to generate deprecation information.void
setDocTitle
(String docTitle) Sets the HTML text to appear in the main frame title.void
Sets the HTML text to appear in the footer for each page.void
Sets the HTML text to appear in the header for each page.void
setStyleSheet
(File styleSheet) Deprecated.Scaladoc does not support to set a stylesheet any more (Scala 2.11).void
Sets the HTML text to appear in the top text for each page.void
setUnchecked
(boolean unchecked) Sets whether to generate unchecked information.void
setWindowTitle
(String windowTitle) Sets the text to appear in the window title.Methods inherited from class org.gradle.api.tasks.compile.AbstractOptions
define, excludeFromAntProperties, optionMap
-
Constructor Details
-
ScalaDocOptions
public ScalaDocOptions()
-
-
Method Details
-
isDeprecation
Tells whether to generate deprecation information. -
setDeprecation
public void setDeprecation(boolean deprecation) Sets whether to generate deprecation information. -
isUnchecked
Tells whether to generate unchecked information. -
setUnchecked
public void setUnchecked(boolean unchecked) Sets whether to generate unchecked information. -
getWindowTitle
Returns the text to appear in the window title. -
setWindowTitle
Sets the text to appear in the window title. -
getDocTitle
Returns the HTML text to appear in the main frame title. -
setDocTitle
Sets the HTML text to appear in the main frame title. -
getHeader
Returns the HTML text to appear in the header for each page. -
setHeader
Sets the HTML text to appear in the header for each page. -
getTop
Returns the HTML text to appear in the top text for each page. -
setTop
Sets the HTML text to appear in the top text for each page. -
getBottom
Returns the HTML text to appear in the bottom text for each page. -
setBottom
Sets the HTML text to appear in the bottom text for each page. -
getStyleSheet
Deprecated.Scaladoc does not support to set a stylesheet any more (Scala 2.11).Returns the style sheet to override default style. -
setStyleSheet
Deprecated.Scaladoc does not support to set a stylesheet any more (Scala 2.11).Sets the style sheet to override default style. -
getAdditionalParameters
Returns the additional parameters passed to the compiler. Each parameter starts with '-'. -
setAdditionalParameters
Sets the additional parameters passed to the compiler. Each parameter must start with '-'. -
getAntPropertyName
- Overrides:
getAntPropertyName
in classAbstractOptions
-
getAntPropertyValue
- Overrides:
getAntPropertyValue
in classAbstractOptions
-