Options for the ScalaDoc tool.
Type | Name 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() 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. |
Methods inherited from class | Name |
---|---|
class AbstractOptions |
define, excludeFromAntProperties, getAntPropertyName, getAntPropertyValue, optionMap |
Returns the additional parameters passed to the compiler. Each parameter starts with '-'.
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.
Returns the style sheet to override default style.
Returns the HTML text to appear in the top text for each page.
Returns the text to appear in the window title.
Tells whether to generate deprecation information.
Tells whether to generate unchecked information.
Sets the additional parameters passed to the compiler. Each parameter must start with '-'.
Sets the HTML text to appear in the bottom text for each page.
Sets whether to generate deprecation information.
Sets the HTML text to appear in the main frame title.
Sets the HTML text to appear in the footer for each page.
Sets the HTML text to appear in the header for each page.
Sets the style sheet to override default style.
Sets the HTML text to appear in the top text for each page.
Sets whether to generate unchecked information.
Sets the text to appear in the window title.