Class ScalaDocOptions

    • 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.
      • setWindowTitle

        public void setWindowTitle​(@Nullable
                                   String windowTitle)
        Sets the text to appear in the window title.
      • setDocTitle

        public void setDocTitle​(@Nullable
                                String docTitle)
        Sets the HTML text to appear in the main frame title.
      • setHeader

        public void setHeader​(@Nullable
                              String header)
        Sets the HTML text to appear in the header for each page.
      • setFooter

        public void setFooter​(@Nullable
                              String footer)
        Sets the HTML text to appear in the footer for each page.
      • setTop

        public void setTop​(@Nullable
                           String top)
        Sets the HTML text to appear in the top 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 '-'.