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 SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionReturns the additional parameters passed to the compiler.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.getTop()Returns the HTML text to appear in the top text for each page.Returns the text to appear in the window title.booleanTells whether to generate deprecation information.booleanTells whether to generate unchecked information.voidsetAdditionalParameters(List<String> additionalParameters) Sets the additional parameters passed to the compiler.voidSets the HTML text to appear in the bottom text for each page.voidsetDeprecation(boolean deprecation) Sets whether to generate deprecation information.voidsetDocTitle(String docTitle) Sets the HTML text to appear in the main frame title.voidSets the HTML text to appear in the footer for each page.voidSets the HTML text to appear in the header for each page.voidSets the HTML text to appear in the top text for each page.voidsetUnchecked(boolean unchecked) Sets whether to generate unchecked information.voidsetWindowTitle(String windowTitle) Sets the text to appear in the window title.Methods inherited from class org.gradle.api.tasks.compile.AbstractOptionsdefine
- 
Constructor Details- 
ScalaDocOptionspublic ScalaDocOptions()
 
- 
- 
Method Details- 
isDeprecationTells whether to generate deprecation information.
- 
setDeprecationpublic void setDeprecation(boolean deprecation) Sets whether to generate deprecation information.
- 
isUncheckedTells whether to generate unchecked information.
- 
setUncheckedpublic void setUnchecked(boolean unchecked) Sets whether to generate unchecked information.
- 
getWindowTitleReturns the text to appear in the window title.
- 
setWindowTitleSets the text to appear in the window title.
- 
getDocTitleReturns the HTML text to appear in the main frame title.
- 
setDocTitleSets the HTML text to appear in the main frame title.
- 
getHeaderReturns the HTML text to appear in the header for each page.
- 
setHeaderSets the HTML text to appear in the header for each page.
- 
getTopReturns the HTML text to appear in the top text for each page.
- 
setTopSets the HTML text to appear in the top text for each page.
- 
getBottomReturns the HTML text to appear in the bottom text for each page.
- 
setBottomSets the HTML text to appear in the bottom text for each page.
- 
getAdditionalParametersReturns the additional parameters passed to the compiler. Each parameter starts with '-'.
- 
setAdditionalParametersSets the additional parameters passed to the compiler. Each parameter must start with '-'.
 
-