Serializable
public class ScalaDocOptions extends AbstractOptions
Constructor | Description |
---|---|
ScalaDocOptions() |
Modifier and Type | Method | Description |
---|---|---|
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() |
Deprecated.
Scaladoc does not support to set a stylesheet any more (Scala 2.11).
|
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) |
Deprecated.
Scaladoc does not support to set a stylesheet any more (Scala 2.11).
|
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.
|
define, excludeFromAntProperties, optionMap
@Input public boolean isDeprecation()
public void setDeprecation(boolean deprecation)
@Input public boolean isUnchecked()
public void setUnchecked(boolean unchecked)
@Input @Optional public String getWindowTitle()
public void setWindowTitle(String windowTitle)
@Input @Optional public String getDocTitle()
public void setDocTitle(String docTitle)
@Input @Optional public String getHeader()
public void setHeader(String header)
@Input @Optional public String getFooter()
public void setFooter(String footer)
@Input @Optional public String getTop()
public void setTop(String top)
@Input @Optional public String getBottom()
public void setBottom(String bottom)
@PathSensitive(ABSOLUTE) @InputFile @Optional @Deprecated public File getStyleSheet()
@Deprecated public void setStyleSheet(File styleSheet)
@Input @Optional public List<String> getAdditionalParameters()
public void setAdditionalParameters(List<String> additionalParameters)
protected String getAntPropertyName(String fieldName)
getAntPropertyName
in class AbstractOptions
protected Object getAntPropertyValue(String fieldName, Object value)
getAntPropertyValue
in class AbstractOptions