Constructor Detail

• ScalaDocOptions

  public ScalaDocOptions()

Method Detail

• isDeprecation

  @Input
  public boolean isDeprecation()

  Tells whether to generate deprecation information.

• setDeprecation

  public void setDeprecation​(boolean deprecation)

  Sets whether to generate deprecation information.

• isUnchecked

  @Input
  public boolean isUnchecked()

  Tells whether to generate unchecked information.

• setUnchecked

  public void setUnchecked​(boolean unchecked)

  Sets whether to generate unchecked information.

• getWindowTitle

  @Nullable
  @Optional
  @Input
  public String getWindowTitle()

  Returns the text to appear in the window title.

• setWindowTitle

  public void setWindowTitle​(@Nullable
                             String windowTitle)

  Sets the text to appear in the window title.

• getDocTitle

  @Nullable
  @Optional
  @Input
  public String getDocTitle()

  Returns the HTML text to appear in the main frame title.

• setDocTitle

  public void setDocTitle​(@Nullable
                          String docTitle)

  Sets the HTML text to appear in the main frame title.

• getHeader

  @Nullable
  @Optional
  @Input
  public String getHeader()

  Returns the HTML text to appear in the header for each page.

• setHeader

  public void setHeader​(@Nullable
                        String header)

  Sets the HTML text to appear in the header for each page.

• getFooter

  @Nullable
  @Optional
  @Input
  public String getFooter()

  Returns the HTML text to appear in the footer for each page.

• setFooter

  public void setFooter​(@Nullable
                        String footer)

  Sets the HTML text to appear in the footer for each page.

• getTop

  @Nullable
  @Optional
  @Input
  public String getTop()

  Returns the HTML text to appear in the top text for each page.

• setTop

  public void setTop​(@Nullable
                     String top)

  Sets the HTML text to appear in the top text for each page.

• getBottom

  @Nullable
  @Optional
  @Input
  public String getBottom()

  Returns the HTML text to appear in the bottom text for each page.

• setBottom

  public void setBottom​(@Nullable
                        String bottom)

  Sets the HTML text to appear in the bottom text for each page.

• getAdditionalParameters

  @Nullable
  @Optional
  @Input
  public List<String> getAdditionalParameters()

  Returns the additional parameters passed to the compiler. Each parameter starts with '-'.

• setAdditionalParameters

  public void setAdditionalParameters​(@Nullable
                                      List<String> additionalParameters)

  Sets the additional parameters passed to the compiler. Each parameter must start with '-'.

• getAntPropertyName

  protected String getAntPropertyName​(String fieldName)

  Overrides:

  getAntPropertyName in class AbstractOptions

• getAntPropertyValue

  protected Object getAntPropertyValue​(String fieldName,
                                       Object value)

  Overrides:

  getAntPropertyValue in class AbstractOptions