public class ScalaDocOptions extends AbstractOptions
Constructor and Description |
---|
ScalaDocOptions() |
Modifier and Type | Method and Description |
---|---|
java.util.List<java.lang.String> |
getAdditionalParameters()
Returns the additional parameters passed to the compiler.
|
protected java.lang.String |
getAntPropertyName(java.lang.String fieldName) |
protected java.lang.Object |
getAntPropertyValue(java.lang.String fieldName,
java.lang.Object value) |
java.lang.String |
getBottom()
Returns the HTML text to appear in the bottom text for each page.
|
java.lang.String |
getDocTitle()
Returns the HTML text to appear in the main frame title.
|
java.lang.String |
getFooter()
Returns the HTML text to appear in the footer for each page.
|
java.lang.String |
getHeader()
Returns the HTML text to appear in the header for each page.
|
java.io.File |
getStyleSheet()
Returns the style sheet to override default style.
|
java.lang.String |
getTop()
Returns the HTML text to appear in the top text for each page.
|
java.lang.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(java.util.List<java.lang.String> additionalParameters)
Sets the additional parameters passed to the compiler.
|
void |
setBottom(java.lang.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(java.lang.String docTitle)
Sets the HTML text to appear in the main frame title.
|
void |
setFooter(java.lang.String footer)
Sets the HTML text to appear in the footer for each page.
|
void |
setHeader(java.lang.String header)
Sets the HTML text to appear in the header for each page.
|
void |
setStyleSheet(java.io.File styleSheet)
Sets the style sheet to override default style.
|
void |
setTop(java.lang.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(java.lang.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 java.lang.String getWindowTitle()
public void setWindowTitle(java.lang.String windowTitle)
@Input @Optional public java.lang.String getDocTitle()
public void setDocTitle(java.lang.String docTitle)
@Input @Optional public java.lang.String getHeader()
public void setHeader(java.lang.String header)
@Input @Optional public java.lang.String getFooter()
public void setFooter(java.lang.String footer)
@Input @Optional public java.lang.String getTop()
public void setTop(java.lang.String top)
@Input @Optional public java.lang.String getBottom()
public void setBottom(java.lang.String bottom)
@InputFile @Optional public java.io.File getStyleSheet()
public void setStyleSheet(java.io.File styleSheet)
@Input @Optional public java.util.List<java.lang.String> getAdditionalParameters()
public void setAdditionalParameters(java.util.List<java.lang.String> additionalParameters)
protected java.lang.String getAntPropertyName(java.lang.String fieldName)
getAntPropertyName
in class AbstractOptions
protected java.lang.Object getAntPropertyValue(java.lang.String fieldName, java.lang.Object value)
getAntPropertyValue
in class AbstractOptions