public class ScalaDocOptions extends AbstractOptions
Constructor and Description |
---|
ScalaDocOptions() |
Modifier and Type | Method and 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)
@Nullable @Optional @Input public String getWindowTitle()
public void setWindowTitle(@Nullable String windowTitle)
@Nullable @Optional @Input public String getDocTitle()
public void setDocTitle(@Nullable String docTitle)
@Nullable @Optional @Input public String getHeader()
public void setHeader(@Nullable String header)
@Nullable @Optional @Input public String getFooter()
public void setFooter(@Nullable String footer)
@Nullable @Optional @Input public String getTop()
public void setTop(@Nullable String top)
@Nullable @Optional @Input public String getBottom()
public void setBottom(@Nullable String bottom)
@Deprecated @Nullable @Optional @PathSensitive(value=ABSOLUTE) @InputFile public File getStyleSheet()
@Deprecated public void setStyleSheet(@Nullable File styleSheet)
@Nullable @Optional @Input public List<String> getAdditionalParameters()
public void setAdditionalParameters(@Nullable List<String> additionalParameters)
protected String getAntPropertyName(String fieldName)
getAntPropertyName
in class AbstractOptions
protected Object getAntPropertyValue(String fieldName, Object value)
getAntPropertyValue
in class AbstractOptions