Package org.jdrupes.mdoclet.internal.doclets.toolkit

Klasse BaseOptions

java.lang.Object
org.jdrupes.mdoclet.internal.doclets.toolkit.BaseOptions
Bekannte direkte Unterklassen:
HtmlOptions
public abstract class BaseOptions extends Object
Storage for the format-independent options supported by the toolkit.

The objects to handle command-line options, and to initialize this object, are all subtypes of BaseOptions.Option, returned by getSupportedOptions().

Some of the methods used to access the values of options have names that begin with a verb, such as copyDocfileSubdirs or showVersion. Unless otherwise stated, these methods should all be taken as just accessing the value of the associated option.

  • Felddetails

  • Konstruktordetails

  • Methodendetails

    • getSupportedOptions

      public Set<? extends BaseOptions.Option> getSupportedOptions()

    • generalValidOptions

      protected boolean generalValidOptions()
      This checks for the validity of the options used by the user.

      As of this writing, this checks only docencoding.

      Gibt zurück:
      true if all the options are valid.

    • addTrailingFileSep

      protected static String addTrailingFileSep(String path)
      Add a trailing file separator, if not found.

      Remove superfluous file separators if any. Preserve the front double file separator for UNC paths.

      Parameter:
      path - Path under consideration.
      Gibt zurück:
      String Properly constructed path string.

    • copyDocfileSubdirs

      public boolean copyDocfileSubdirs()
      Argument for command-line option -docfilessubdirs.

      True if we should recursively copy the doc-file subdirectories

    • date

      public ZonedDateTime date()
      Argument for command-line option –date.

    • docEncoding

      public String docEncoding()
      Argument for command-line option -docencoding.

      Encoding for this document. Default is default encoding for this platform.

    • setDocEncoding

      public void setDocEncoding(String docEncoding)

    • encoding

      public String encoding()
      Argument for command-line option -encoding.

      Encoding for this document. Default is default encoding for this platform.

    • javafx

      public boolean javafx()
      Argument for command-line option –javafx or -javafx.

      Generate documentation for JavaFX getters and setters automatically by copying it from the appropriate property definition.

    • setJavaFX

      public void setJavaFX(boolean javafx)

    • keywords

      public boolean keywords()
      Argument for command-line option -keywords.

      True if user wants to add member names as meta keywords. Set to false because meta keywords are ignored in general by most Internet search engines.

    • linkModularityMismatch

      public BaseOptions.ModularityMismatchPolicy linkModularityMismatch()
      Argument for command-line option –link-modularity-mismatch.

      Describes how to handle external documentation with non-matching modularity.

    • linkSource

      public boolean linkSource()
      Argument for command-line option -linksource.

      True if we should generate browsable sources.

    • noComment

      public boolean noComment()
      Argument for command-line option -nocomment.

      True if user wants to suppress descriptions and tags.

    • noDeprecated

      public boolean noDeprecated()
      Argument for command-line option -nodeprecated.

      Don’t generate deprecated API information at all if -nodeprecated option is used. noDeprecated is set to true if -nodeprecated option is used. Default is generate deprecated API information.

    • noPlatformLinks

      public boolean noPlatformLinks()
      Argument for command-line option –no-platform-links.

      True if command-line option –no-platform-links" is used. Default value is false.

    • noSince

      public boolean noSince()
      Argument for command-line option -nosince.

      True if command-line option -nosince" is used. Default value is false.

    • noTimestamp

      public boolean noTimestamp()
      Argument for command-line option -notimestamp.

      True if user wants to suppress time stamp in output. Default is false.

    • serialWarn

      public boolean serialWarn()
      Argument for command-line option -serialwarn.

      This is true if option “-serialwarn” is used. Default value is false to suppress excessive warnings about serial tag.

    • showAuthor

      public boolean showAuthor()
      Argument for command-line option -author.

      Generate author specific information for all the classes if @author tag is used in the doc comment and if -author option is used. showauthor is set to true if -author option is used. Default is don’t show author information.

    • showTaglets

      public boolean showTaglets()
      Argument for command-line option –show-taglets.

      Show taglets (internal debug switch)

    • showVersion

      public boolean showVersion()
      Argument for command-line option -version.

      Generate version specific information for the all the classes if @version tag is used in the doc comment and if -version option is used. showVersion is set to true if -version option is used. Default is don’t show version information.

    • since

      public List<String> since()
      Arguments for command line option –since.

    • sinceLabel

      public String sinceLabel()
      Arguments for command line option –since-label.

    • sourceTabSize

      public int sourceTabSize()
      Argument for command-line option -sourcetab.

      The specified amount of space between tab stops.

    • specBaseURI

      public URI specBaseURI()
      Argument for command-line option –spec-base-url.

      The base URL for relative URLs in @spec tags.

    • summarizeOverriddenMethods

      public boolean summarizeOverriddenMethods()
      Value for command-line option –override-methods summary or –override-methods detail.

      Specifies whether those methods that override a supertype’s method with no changes to the API contract should be summarized in the footnote section.

    • tagletPath

      public String tagletPath()
      Argument for command-line option -tagletpath.

      The path to Taglets

    • snippetPath

      public String snippetPath()
      Argument for command-line option –snippet-path.

      The path for external snippets.