java.io.Serializable
public abstract class ScalaDocOptions extends AbstractOptions
Constructor | Description |
---|---|
ScalaDocOptions() |
Modifier and Type | Method | Description |
---|---|---|
java.util.List<java.lang.String> |
getAdditionalParameters() |
Returns the additional parameters passed to the compiler.
|
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.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 |
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
@Input public boolean isDeprecation()
public void setDeprecation(boolean deprecation)
@Input public boolean isUnchecked()
public void setUnchecked(boolean unchecked)
@Nullable @Optional @Input public java.lang.String getWindowTitle()
public void setWindowTitle(@Nullable java.lang.String windowTitle)
@Nullable @Optional @Input public java.lang.String getDocTitle()
public void setDocTitle(@Nullable java.lang.String docTitle)
@Nullable @Optional @Input public java.lang.String getHeader()
public void setHeader(@Nullable java.lang.String header)
@Nullable @Optional @Input public java.lang.String getFooter()
public void setFooter(@Nullable java.lang.String footer)
@Nullable @Optional @Input public java.lang.String getTop()
public void setTop(@Nullable java.lang.String top)
@Nullable @Optional @Input public java.lang.String getBottom()
public void setBottom(@Nullable java.lang.String bottom)
@Nullable @Optional @Input public java.util.List<java.lang.String> getAdditionalParameters()
public void setAdditionalParameters(@Nullable java.util.List<java.lang.String> additionalParameters)