ScalaDocOptions (Gradle API 2.2-20140924021627+0000)

java.lang.Object
- org.gradle.api.tasks.compile.AbstractOptions
- - org.gradle.api.tasks.scala.ScalaDocOptions

すべての実装されたインタフェース:

Serializable
```
public class ScalaDocOptions
extends AbstractOptions
```
Options for the ScalaDoc tool.

関連項目:

直列化された形式

コンストラクタの概要

コンストラクタ
コンストラクタと説明

ScalaDocOptions()

コンストラクタ
コンストラクタと説明
`ScalaDocOptions()`

メソッドの概要

All Methods Instance Methods Concrete Methods
修飾子とタイプ	メソッドと説明
`List<String>`	`getAdditionalParameters()` Returns the additional parameters passed to the compiler.
`protected String`	`getAntPropertyName(String fieldName)`
`protected Object`	`getAntPropertyValue(String fieldName, Object value)`
`String`	`getBottom()` Returns the HTML text to appear in the bottom text for each page.
`String`	`getDocTitle()` Returns the HTML text to appear in the main frame title.
`String`	`getFooter()` Returns the HTML text to appear in the footer for each page.
`String`	`getHeader()` Returns the HTML text to appear in the header for each page.
`File`	`getStyleSheet()` Returns the style sheet to override default style.
`String`	`getTop()` Returns the HTML text to appear in the top text for each page.
`String`	`getWindowTitle()` Returns the text to appear in the window title.
`boolean`	`isDeprecation()` Tells whether to generate deprecation information.
`boolean`	`isUnchecked()` Tells whether to generate unchecked information.
`void`	`setAdditionalParameters(List<String> additionalParameters)` Sets the additional parameters passed to the compiler.
`void`	`setBottom(String bottom)` 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`	`setFooter(String footer)` Sets the HTML text to appear in the footer for each page.
`void`	`setHeader(String header)` Sets the HTML text to appear in the header for each page.
`void`	`setStyleSheet(File styleSheet)` Sets the style sheet to override default style.
`void`	`setTop(String top)` 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.

クラスから継承されたメソッド org.gradle.api.tasks.compile.AbstractOptions
define, excludeFromAntProperties, optionMap

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - ScalaDocOptions
```
public ScalaDocOptions()
```
- メソッドの詳細
  - isDeprecation
```
@Input
public boolean isDeprecation()
```
    Tells whether to generate deprecation information.
  - setDeprecation
```
public void setDeprecation(boolean deprecation)
```
    Sets whether to generate deprecation information.
  - isUnchecked
```
@Input
public boolean isUnchecked()
```
    Tells whether to generate unchecked information.
  - setUnchecked
```
public void setUnchecked(boolean unchecked)
```
    Sets whether to generate unchecked information.
  - getWindowTitle
```
@Input
 @Optional
public String getWindowTitle()
```
    Returns the text to appear in the window title.
  - setWindowTitle
```
public void setWindowTitle(String windowTitle)
```
    Sets the text to appear in the window title.
  - getDocTitle
```
@Input
 @Optional
public String getDocTitle()
```
    Returns the HTML text to appear in the main frame title.
  - setDocTitle
```
public void setDocTitle(String docTitle)
```
    Sets the HTML text to appear in the main frame title.
  - getHeader
```
@Input
 @Optional
public String getHeader()
```
    Returns the HTML text to appear in the header for each page.
  - setHeader
```
public void setHeader(String header)
```
    Sets the HTML text to appear in the header for each page.
  - getFooter
```
@Input
 @Optional
public String getFooter()
```
    Returns the HTML text to appear in the footer for each page.
  - setFooter
```
public void setFooter(String footer)
```
    Sets the HTML text to appear in the footer for each page.
  - getTop
```
@Input
 @Optional
public String getTop()
```
    Returns the HTML text to appear in the top text for each page.
  - setTop
```
public void setTop(String top)
```
    Sets the HTML text to appear in the top text for each page.
  - getBottom
```
@Input
 @Optional
public String getBottom()
```
    Returns the HTML text to appear in the bottom text for each page.
  - setBottom
```
public void setBottom(String bottom)
```
    Sets the HTML text to appear in the bottom text for each page.
  - getStyleSheet
```
@InputFile
 @Optional
public File getStyleSheet()
```
    Returns the style sheet to override default style.
  - setStyleSheet
```
public void setStyleSheet(File styleSheet)
```
    Sets the style sheet to override default style.
  - getAdditionalParameters
```
@Input
 @Optional
public List<String> getAdditionalParameters()
```
    Returns the additional parameters passed to the compiler. Each parameter starts with '-'.
  - setAdditionalParameters
```
public void setAdditionalParameters(List<String> additionalParameters)
```
    Sets the additional parameters passed to the compiler. Each parameter must start with '-'.
  - getAntPropertyName
```
protected String getAntPropertyName(String fieldName)
```
    オーバーライド:
    
    getAntPropertyName クラス内 AbstractOptions
  - getAntPropertyValue
```
protected Object getAntPropertyValue(String fieldName,
                                     Object value)
```
    オーバーライド:
    
    getAntPropertyValue クラス内 AbstractOptions

クラス ScalaDocOptions

コンストラクタの概要

メソッドの概要

クラスから継承されたメソッド org.gradle.api.tasks.compile.AbstractOptions

クラスから継承されたメソッド java.lang.Object

コンストラクタの詳細

ScalaDocOptions

メソッドの詳細

isDeprecation

setDeprecation

isUnchecked

setUnchecked

getWindowTitle

setWindowTitle

getDocTitle

setDocTitle

getHeader

setHeader

getFooter

setFooter

getTop

setTop

getBottom

setBottom

getStyleSheet

setStyleSheet

getAdditionalParameters

setAdditionalParameters

getAntPropertyName

getAntPropertyValue