Class StandardJavadocDocletOptions

java.lang.Object
org.gradle.external.javadoc.CoreJavadocOptions
org.gradle.external.javadoc.StandardJavadocDocletOptions
All Implemented Interfaces:
MinimalJavadocOptions
public class StandardJavadocDocletOptions extends CoreJavadocOptions implements MinimalJavadocOptions
Provides the options for the standard Javadoc doclet.
Since:
0.7

  • Field Details

  • Constructor Details

    • StandardJavadocDocletOptions

      public StandardJavadocDocletOptions()
      Creates a new StandardJavadocDocletOptions.
      Since:
      0.7

    • StandardJavadocDocletOptions

      public StandardJavadocDocletOptions(org.gradle.external.javadoc.internal.JavadocOptionFile javadocOptionFile)
      Creates a new StandardJavadocDocletOptions.
      Since:
      0.7

    • StandardJavadocDocletOptions

      public StandardJavadocDocletOptions(StandardJavadocDocletOptions original)
      Creates a new StandardJavadocDocletOptions.
      Since:
      3.4

    • StandardJavadocDocletOptions

      public StandardJavadocDocletOptions(StandardJavadocDocletOptions original, org.gradle.external.javadoc.internal.JavadocOptionFile optionFile)
      Creates a new StandardJavadocDocletOptions.
      Since:
      3.4

    • StandardJavadocDocletOptions

      public StandardJavadocDocletOptions(MinimalJavadocOptions original)
      Creates a new StandardJavadocDocletOptions.
      Since:
      3.4

  • Method Details

    • knownOptionNames

      @Incubating public Set<String> knownOptionNames()
      Gets a set of all the options that are known to this class and its super class and have separate properties.
      Overrides:
      knownOptionNames in class CoreJavadocOptions
      Returns:
      set of property names
      Since:
      7.5

    • getDestinationDirectory

      public File getDestinationDirectory()
      -d directory

      Specifies the destination directory where javadoc saves the generated HTML files. (The "d" means "destination.") Omitting this option causes the files to be saved to the current directory. The value directory can be absolute, or relative to the current working directory. As of 1.4, the destination directory is automatically created when javadoc is run. For example, the following generates the documentation for the package com.mypackage and saves the results in the C:/user/doc/ directory:

      javadoc -d /user/doc com.mypackage

      Specified by:
      getDestinationDirectory in interface MinimalJavadocOptions

    • setDestinationDirectory

      public void setDestinationDirectory(File directory)
      Description copied from interface: MinimalJavadocOptions
      Sets the destination directory.
      Specified by:
      setDestinationDirectory in interface MinimalJavadocOptions

    • destinationDirectory

      public StandardJavadocDocletOptions destinationDirectory(File destinationDirectory)
      Description copied from interface: MinimalJavadocOptions
      Destination directory.
      Specified by:
      destinationDirectory in interface MinimalJavadocOptions

    • isUse

      @Input public boolean isUse()
      -use

      Includes one "Use" page for each documented class and package. The page describes what packages, classes, methods, constructors and fields use any API of the given class or package. Given class C, things that use class C would include subclasses of C, fields declared as C, methods that return C, and methods and constructors with parameters of type C. For example, let's look at what might appear on the "Use" page for String. The getName() method in the java.awt.Font class returns type String. Therefore, getName() uses String, and you will find that method on the "Use" page for String.

      Note that this documents only uses of the API, not the implementation. If a method uses String in its implementation but does not take a string as an argument or return a string, that is not considered a "use" of String.

      You can access the generated "Use" page by first going to the class or package, then clicking on the "Use" link in the navigation bar.

      Since:
      0.7

    • setUse

      public void setUse(boolean use)
      Sets the use.
      Since:
      0.7

    • use

      public StandardJavadocDocletOptions use(boolean use)
      Use.
      Since:
      0.7

    • use

      public StandardJavadocDocletOptions use()
      Use.
      Since:
      0.7

    • isVersion

      @Input public boolean isVersion()
      -version

      Includes the @version text in the generated docs. This text is omitted by default. To tell what version of the Javadoc tool you are using, use the -J-version option.

      Since:
      0.7

    • setVersion

      public void setVersion(boolean version)
      Sets the version.
      Since:
      0.7

    • version

      public StandardJavadocDocletOptions version(boolean version)
      Version.
      Since:
      0.7

    • version

      public StandardJavadocDocletOptions version()
      Version.
      Since:
      0.7

    • isAuthor

      @Input public boolean isAuthor()
      -author

      Includes the @author text in the generated docs.

      Since:
      0.7

    • setAuthor

      public void setAuthor(boolean author)
      Sets the author.
      Since:
      0.7

    • author

      public StandardJavadocDocletOptions author(boolean author)
      Author.
      Since:
      0.7

    • author

      public StandardJavadocDocletOptions author()
      Author.
      Since:
      0.7

    • isSplitIndex

      @Input public boolean isSplitIndex()
      -splitindex

      Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.

      Since:
      0.7

    • setSplitIndex

      public void setSplitIndex(boolean splitIndex)
      Sets the split index.
      Since:
      0.7

    • splitIndex

      public StandardJavadocDocletOptions splitIndex(boolean splitIndex)
      Split index.
      Since:
      0.7

    • splitIndex

      public StandardJavadocDocletOptions splitIndex()
      Split index.
      Since:
      0.7

    • getWindowTitle

      public String getWindowTitle()
      -windowtitle title

      Specifies the title to be placed in the HTML <title> tag. This appears in the window title and in any browser bookmarks (favorite places) that someone creates for this page. This title should not contain any HTML tags, as the browser will not properly interpret them. Any internal quotation marks within title may have to be escaped. If -windowtitle is omitted, the Javadoc tool uses the value of -doctitle for this option. javadoc -windowtitle "Java 2 Platform" com.mypackage

      Specified by:
      getWindowTitle in interface MinimalJavadocOptions

    • setWindowTitle

      public void setWindowTitle(String windowTitle)
      Description copied from interface: MinimalJavadocOptions
      Sets the window title.
      Specified by:
      setWindowTitle in interface MinimalJavadocOptions

    • windowTitle

      public StandardJavadocDocletOptions windowTitle(String windowTitle)
      Description copied from interface: MinimalJavadocOptions
      Window title.
      Specified by:
      windowTitle in interface MinimalJavadocOptions

    • getHeader

      public String getHeader()
      -header header

      Specifies the header text to be placed at the top of each output file. The header will be placed to the right of the upper navigation bar. header may contain HTML tags and white space, though if it does, it must be enclosed in quotes. Any internal quotation marks within header may have to be escaped. javadoc -header "Java 2 Platform
      v1.4" com.mypackage

      Specified by:
      getHeader in interface MinimalJavadocOptions

    • setHeader

      public void setHeader(String header)
      Description copied from interface: MinimalJavadocOptions
      Sets the header.
      Specified by:
      setHeader in interface MinimalJavadocOptions

    • header

      public StandardJavadocDocletOptions header(String header)
      Description copied from interface: MinimalJavadocOptions
      Header.
      Specified by:
      header in interface MinimalJavadocOptions

    • getDocTitle

      @Optional @Input public @Nullable String getDocTitle()
      -doctitle title

      Specifies the title to be placed near the top of the overview summary file. The title will be placed as a centered, level-one heading directly beneath the upper navigation bar. The title may contain HTML tags and white space, though if it does, it must be enclosed in quotes. Any internal quotation marks within title may have to be escaped. javadoc -doctitle "Java<sup><font size=\"-2\">TM</font></sup>" com.mypackage

      Since:
      0.7

    • setDocTitle

      public void setDocTitle(@Nullable String docTitle)
      Sets the doc title.
      Since:
      0.7

    • docTitle

      public StandardJavadocDocletOptions docTitle(String docTitle)
      Doc title.
      Since:
      0.7

    • getFooter

      @Optional @Input public @Nullable String getFooter()
      -footer footer

      Specifies the footer text to be placed at the bottom of each output file. The footer will be placed to the right of the lower navigation bar. footer may contain HTML tags and white space, though if it does, it must be enclosed in quotes. Any internal quotation marks within footer may have to be escaped.

      Since:
      0.7

    • setFooter

      public void setFooter(@Nullable String footer)
      Sets the footer.
      Since:
      0.7

    • footer

      public StandardJavadocDocletOptions footer(String footer)
      Footer.
      Since:
      0.7

    • getBottom

      @Optional @Input public @Nullable String getBottom()
      -bottom text

      Specifies the text to be placed at the bottom of each output file. The text will be placed at the bottom of the page, below the lower navigation bar. The text may contain HTML tags and white space, though if it does, it must be enclosed in quotes. Any internal quotation marks within text may have to be escaped.

      Since:
      0.7

    • setBottom

      public void setBottom(@Nullable String bottom)
      Sets the bottom.
      Since:
      0.7

    • bottom

      public StandardJavadocDocletOptions bottom(String bottom)
      Bottom.
      Since:
      0.7

    • getLinks

      @Optional @Input public @Nullable List<String> getLinks()
      -link extdocURL

      Creates links to existing javadoc-generated documentation of external referenced classes. It takes one argument:

      extdocURL is the absolute or relative URL of the directory containing the external javadoc-generated documentation you want to link to. Examples are shown below. The package-list file must be found in this directory (otherwise, use -linkoffline). The Javadoc tool reads the package names from the package-list file and then links to those packages at that URL. When the Javadoc tool is run, the extdocURL value is copied literally into the <A HREF> links that are created. Therefore, extdocURL must be the URL to the directory, not to a file. You can use an absolute link for extdocURL to enable your docs to link to a document on any website, or can use a relative link to link only to a relative location. If relative, the value you pass in should be the relative path from the destination directory (specified with -d) to the directory containing the packages being linked to.

      When specifying an absolute link you normally use an http: link. However, if you want to link to a file system that has no web server, you can use a file: link -- however, do this only if everyone wanting to access the generated documentation shares the same file system.

      Since:
      0.7

    • setLinks

      public void setLinks(@Nullable List<String> links)
      Sets the links.
      Since:
      0.7

    • links

      public StandardJavadocDocletOptions links(String... links)
      Links.
      Since:
      0.7

    • linksFile

      public StandardJavadocDocletOptions linksFile(File linksFile)
      Links file.
      Since:
      0.7

    • getLinksOffline

      @Optional @Input public @Nullable List<JavadocOfflineLink> getLinksOffline()
      -linkoffline extdocURL packagelistLoc

      This option is a variation of -link; they both create links to javadoc-generated documentation for external referenced classes. Use the -linkoffline option when linking to a document on the web when the Javadoc tool itself is "offline" -- that is, it cannot access the document through a web connection. More specifically, use -linkoffline if the external document's package-list file is not accessible or does not exist at the extdocURL location but does exist at a different location, which can be specified by packageListLoc (typically local). Thus, if extdocURL is accessible only on the World Wide Web, -linkoffline removes the constraint that the Javadoc tool have a web connection when generating the documentation.

      Another use is as a "hack" to update docs: After you have run javadoc on a full set of packages, then you can run javadoc again on only a smaller set of changed packages, so that the updated files can be inserted back into the original set. Examples are given below.

      The -linkoffline option takes two arguments -- the first for the string to be embedded in the <a href> links, the second telling it where to find package-list:

      extdocURL is the absolute or relative URL of the directory containing the external javadoc-generated documentation you want to link to. If relative, the value should be the relative path from the destination directory (specified with -d) to the root of the packages being linked to. For more details, see extdocURL in the -link option. packagelistLoc is the path or URL to the directory containing the package-list file for the external documentation. This can be a URL (http: or file:) or file path, and can be absolute or relative. If relative, make it relative to the current directory from where javadoc was run. Do not include the package-list filename.

      Since:
      0.7

    • setLinksOffline

      public void setLinksOffline(@Nullable List<JavadocOfflineLink> linksOffline)
      Sets the links offline.
      Since:
      0.7

    • linksOffline

      public StandardJavadocDocletOptions linksOffline(String extDocUrl, String packageListLoc)
      Links offline.
      Since:
      0.7

    • linksOfflineFile

      public StandardJavadocDocletOptions linksOfflineFile(File linksOfflineFile)
      Links offline file.
      Since:
      0.7

    • isLinkSource

      @Input public boolean isLinkSource()
      -linksource

      Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation. Links are created for classes, interfaces, constructors, methods and fields whose declarations are in a source file. Otherwise, links are not created, such as for default constructors and generated classes. This option exposes all private implementation details in the included source files, including private classes, private fields, and the bodies of private methods, regardless of the -public, -package, -protected and -private options. Unless you also use the -private option, not all private classes or interfaces will necessarily be accessible via links.

      Each link appears on the name of the identifier in its declaration. For example, the link to the source code of the Button class would be on the word "Button":

      public class Button extends Component implements Accessible and the link to the source code of the getLabel() method in the Button class would be on the word "getLabel": public String getLabel()

      Since:
      0.7

    • setLinkSource

      public void setLinkSource(boolean linkSource)
      Sets the link source.
      Since:
      0.7

    • linkSource

      public StandardJavadocDocletOptions linkSource(boolean linkSource)
      Link source.
      Since:
      0.7

    • linkSource

      public StandardJavadocDocletOptions linkSource()
      Link source.
      Since:
      0.7

    • getGroups

      @Optional @Input public @Nullable Map<String, List<String>> getGroups()
      -group groupheading packagepattern:packagepattern:...

      Separates packages on the overview page into whatever groups you specify, one group per table. You specify each group with a different -group option. The groups appear on the page in the order specified on the command line; packages are alphabetized within a group. For a given -group option, the packages matching the list of packagepattern expressions appear in a table with the heading groupheading.

      groupheading can be any text, and can include white space. This text is placed in the table heading for the group. packagepattern can be any package name, or can be the start of any package name followed by an asterisk (*). The asterisk is a wildcard meaning "match any characters". This is the only wildcard allowed. Multiple patterns can be included in a group by separating them with colons (:).

      NOTE: If using an asterisk in a pattern or pattern list, the pattern list must be inside quotes, such as "java.lang*:java.util"

      If you do not supply any -group option, all packages are placed in one group with the heading "Packages". If the all groups do not include all documented packages, any leftover packages appear in a separate group with the heading "Other Packages".

      For example, the following option separates the four documented packages into core, extension and other packages. Notice the trailing "dot" does not appear in "java.lang*" -- including the dot, such as "java.lang.*" would omit the java.lang package.

      javadoc -group "Core Packages" "java.lang*:java.util" -group "Extension Packages" "javax.*" java.lang java.lang.reflect java.util javax.servlet java.new

      This results in the groupings:

      Core Packages
      java.lang
      java.lang.reflect
      java.util

      Extension Packages
      javax.servlet

      Other Packages
      java.new

      Since:
      0.7

    • setGroups

      public void setGroups(@Nullable Map<String, List<String>> groups)
      Sets the groups.
      Since:
      0.7

    • group

      public StandardJavadocDocletOptions group(Map<String, List<String>> groups)
      Group.
      Since:
      0.7

    • group

      public StandardJavadocDocletOptions group(String groupName, List<String> packagePatterns)
      Group.
      Since:
      0.7

    • group

      public StandardJavadocDocletOptions group(String groupName, String... packagePatterns)
      Group.
      Since:
      0.7

    • groupsFile

      public StandardJavadocDocletOptions groupsFile(File groupsFile)
      Groups file.
      Since:
      0.7

    • isNoDeprecated

      @Input public boolean isNoDeprecated()
      -nodeprecated

      Prevents the generation of any deprecated API at all in the documentation. This does what -nodeprecatedlist does, plus it does not generate any deprecated API throughout the rest of the documentation. This is useful when writing code and you don't want to be distracted by the deprecated code.

      Since:
      0.7

    • setNoDeprecated

      public void setNoDeprecated(boolean noDeprecated)
      Sets the no deprecated.
      Since:
      0.7

    • noDeprecated

      public StandardJavadocDocletOptions noDeprecated(boolean noDeprecated)
      No deprecated.
      Since:
      0.7

    • noDeprecated

      public StandardJavadocDocletOptions noDeprecated()
      No deprecated.
      Since:
      0.7

    • isNoDeprecatedList

      @Input public boolean isNoDeprecatedList()
      -nodeprecatedlist

      Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page. (However, javadoc continues to generate the deprecated API throughout the rest of the document.) This is useful if your source code contains no deprecated API, and you want to make the navigation bar cleaner.

      Since:
      0.7

    • setNoDeprecatedList

      public void setNoDeprecatedList(boolean noDeprecatedList)
      Sets the no deprecated list.
      Since:
      0.7

    • noDeprecatedList

      public StandardJavadocDocletOptions noDeprecatedList(boolean noDeprecatedList)
      No deprecated list.
      Since:
      0.7

    • noDeprecatedList

      public StandardJavadocDocletOptions noDeprecatedList()
      No deprecated list.
      Since:
      0.7

    • isNoSince

      @Input public boolean isNoSince()
      -nosince

      Omits from the generated docs the "Since" sections associated with the @since tags.

      Since:
      0.7

    • setNoSince

      public void setNoSince(boolean noSince)
      Sets the no since.
      Since:
      0.7

    • noSince

      public StandardJavadocDocletOptions noSince(boolean noSince)
      No since.
      Since:
      0.7

    • noSince

      public StandardJavadocDocletOptions noSince()
      No since.
      Since:
      0.7

    • isNoTree

      @Input public boolean isNoTree()
      -notree

      Omits the class/interface hierarchy pages from the generated docs. These are the pages you reach using the "Tree" button in the navigation bar. The hierarchy is produced by default.

      Since:
      0.7

    • setNoTree

      public void setNoTree(boolean noTree)
      Sets the no tree.
      Since:
      0.7

    • noTree

      public StandardJavadocDocletOptions noTree(boolean noTree)
      No tree.
      Since:
      0.7

    • noTree

      public StandardJavadocDocletOptions noTree()
      No tree.
      Since:
      0.7

    • isNoIndex

      @Input public boolean isNoIndex()
      -noindex

      Omits the index from the generated docs. The index is produced by default.

      Since:
      0.7

    • setNoIndex

      public void setNoIndex(boolean noIndex)
      Sets the no index.
      Since:
      0.7

    • noIndex

      public StandardJavadocDocletOptions noIndex(boolean noIndex)
      No index.
      Since:
      0.7

    • noIndex

      public StandardJavadocDocletOptions noIndex()
      No index.
      Since:
      0.7

    • isNoHelp

      @Input public boolean isNoHelp()
      -nohelp

      Omits the HELP link in the navigation bars at the top and bottom of each page of output.

      Since:
      0.7

    • setNoHelp

      public void setNoHelp(boolean noHelp)
      Sets the no help.
      Since:
      0.7

    • noHelp

      public StandardJavadocDocletOptions noHelp(boolean noHelp)
      No help.
      Since:
      0.7

    • noHelp

      public StandardJavadocDocletOptions noHelp()
      No help.
      Since:
      0.7

    • isNoNavBar

      @Input public boolean isNoNavBar()
      -nonavbar

      Prevents the generation of the navigation bar, header and footer, otherwise found at the top and bottom of the generated pages. Has no affect on the "bottom" option. The -nonavbar option is useful when you are interested only in the content and have no need for navigation, such as converting the files to PostScript or PDF for print only.

      Since:
      0.7

    • setNoNavBar

      public void setNoNavBar(boolean noNavBar)
      Sets the no nav bar.
      Since:
      0.7

    • noNavBar

      public StandardJavadocDocletOptions noNavBar(boolean noNavBar)
      No nav bar.
      Since:
      0.7

    • noNavBar

      public StandardJavadocDocletOptions noNavBar()
      No nav bar.
      Since:
      0.7

    • getHelpFile

      @Optional @PathSensitive(NAME_ONLY) @InputFile public @Nullable File getHelpFile()
      -helpfile path/filename

      Specifies the path of an alternate help file path\filename that the HELP link in the top and bottom navigation bars link to. Without this option, the Javadoc tool automatically creates a help file help-doc.html that is hard-coded in the Javadoc tool. This option enables you to override this default. The filename can be any name and is not restricted to help-doc.html -- the Javadoc tool will adjust the links in the navigation bar accordingly. For example:

      javadoc -helpfile C:/user/myhelp.html java.awt

      Since:
      0.7

    • setHelpFile

      public void setHelpFile(@Nullable File helpFile)
      Sets the help file.
      Since:
      0.7

    • helpFile

      public StandardJavadocDocletOptions helpFile(File helpFile)
      Help file.
      Since:
      0.7

    • getStylesheetFile

      @Optional @PathSensitive(NAME_ONLY) @InputFile public @Nullable File getStylesheetFile()
      -stylesheetfile path\filename

      Specifies the path of an alternate HTML stylesheet file. Without this option, the Javadoc tool automatically creates a stylesheet file stylesheet.css that is hard-coded in the Javadoc tool. This option enables you to override this default. The filename can be any name and is not restricted to stylesheet.css. For example:

      javadoc -stylesheetfile C:/user/mystylesheet.css com.mypackage

      Since:
      0.7

    • setStylesheetFile

      public void setStylesheetFile(@Nullable File stylesheetFile)
      Sets the stylesheet file.
      Since:
      0.7

    • stylesheetFile

      public StandardJavadocDocletOptions stylesheetFile(File stylesheetFile)
      Stylesheet file.
      Since:
      0.7

    • isSerialWarn

      @Input public boolean isSerialWarn()
      -serialwarn

      Generates compile-time warnings for missing @serial tags. By default, Javadoc 1.2.2 (and later versions) generates no serial warnings. (This is a reversal from earlier versions.) Use this option to display the serial warnings, which helps to properly document default serializable fields and writeExternal methods.

      Since:
      0.7

    • setSerialWarn

      public void setSerialWarn(boolean serialWarn)
      Sets the serial warn.
      Since:
      0.7

    • serialWarn

      public StandardJavadocDocletOptions serialWarn(boolean serialWarn)
      Serial warn.
      Since:
      0.7

    • serialWarn

      public StandardJavadocDocletOptions serialWarn()
      Serial warn.
      Since:
      0.7

    • getCharSet

      @Optional @Input public @Nullable String getCharSet()
      -charset name Specifies the HTML character set for this document. The name should be a preferred MIME name as given in the IANA Registry. For example:

      javadoc -charset "iso-8859-1" mypackage

      would insert the following line in the head of every generated page:

      <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">

      This META tag is described in the HTML standard. (4197265 and 4137321)

      Also see -encoding and -docencoding.

      Since:
      0.7

    • setCharSet

      public void setCharSet(@Nullable String charSet)
      Sets the char set.
      Since:
      0.7

    • charSet

      public StandardJavadocDocletOptions charSet(String charSet)
      Char set.
      Since:
      0.7

    • getDocEncoding

      @Optional @Input public @Nullable String getDocEncoding()
      -docencoding name

      Specifies the encoding of the generated HTML files. The name should be a preferred MIME name as given in the IANA Registry. If you omit this option but use -encoding, then the encoding of the generated HTML files is determined by -encoding. Example:

      % javadoc -docencoding "ISO-8859-1" mypackage

      Also see -encoding and -charset.

      Since:
      0.7

    • setDocEncoding

      public void setDocEncoding(@Nullable String docEncoding)
      Sets the doc encoding.
      Since:
      0.7

    • docEncoding

      public StandardJavadocDocletOptions docEncoding(String docEncoding)
      Doc encoding.
      Since:
      0.7

    • isKeyWords

      @Input public boolean isKeyWords()
      -keywords.
      Since:
      0.7

    • setKeyWords

      public void setKeyWords(boolean keyWords)
      Sets the key words.
      Since:
      0.7

    • keyWords

      public StandardJavadocDocletOptions keyWords(boolean keyWords)
      Key words.
      Since:
      0.7

    • keyWords

      public StandardJavadocDocletOptions keyWords()
      Key words.
      Since:
      0.7

    • getTags

      @Optional @Input public @Nullable List<String> getTags()
      -tag tagname:Xaoptcmf:"taghead".
      Since:
      0.7

    • setTags

      public void setTags(@Nullable List<String> tags)
      Sets the tags.
      Since:
      0.7

    • tags

      public StandardJavadocDocletOptions tags(List<String> tags)
      Tags.
      Since:
      0.7

    • tags

      public StandardJavadocDocletOptions tags(String... tags)
      Tags.
      Since:
      0.7

    • tagsFile

      public StandardJavadocDocletOptions tagsFile(File tagsFile)
      Tags file.
      Since:
      0.7

    • getTaglets

      @Optional @Input public @Nullable List<String> getTaglets()
      -taglet class.
      Since:
      1.0

    • setTaglets

      public void setTaglets(@Nullable List<String> taglets)
      Sets the taglets.
      Since:
      1.0

    • taglets

      public StandardJavadocDocletOptions taglets(List<String> taglets)
      Taglets.
      Since:
      1.0

    • taglets

      public StandardJavadocDocletOptions taglets(String... taglets)
      Taglets.
      Since:
      0.7

    • getTagletPath

      @Optional @Classpath public @Nullable List<File> getTagletPath()
      -tagletpath tagletpathlist.
      Since:
      0.7

    • setTagletPath

      public void setTagletPath(@Nullable List<File> tagletPath)
      Sets the taglet path.
      Since:
      0.7

    • tagletPath

      public StandardJavadocDocletOptions tagletPath(List<File> tagletPath)
      Taglet path.
      Since:
      0.7

    • tagletPath

      public StandardJavadocDocletOptions tagletPath(File... tagletPath)
      Taglet path.
      Since:
      0.7

    • isDocFilesSubDirs

      @Input public boolean isDocFilesSubDirs()
      -docfilessubdirs.
      Since:
      0.7

    • setDocFilesSubDirs

      public void setDocFilesSubDirs(boolean docFilesSubDirs)
      Sets the doc files sub dirs.
      Since:
      0.7

    • docFilesSubDirs

      public StandardJavadocDocletOptions docFilesSubDirs(boolean docFilesSubDirs)
      Doc files sub dirs.
      Since:
      0.7

    • docFilesSubDirs

      public StandardJavadocDocletOptions docFilesSubDirs()
      Doc files sub dirs.
      Since:
      0.7

    • getExcludeDocFilesSubDir

      @Optional @Input public @Nullable List<String> getExcludeDocFilesSubDir()
      -excludedocfilessubdir name1:name2...
      Since:
      0.7

    • setExcludeDocFilesSubDir

      public void setExcludeDocFilesSubDir(@Nullable List<String> excludeDocFilesSubDir)
      Sets the exclude doc files sub dir.
      Since:
      0.7

    • excludeDocFilesSubDir

      public StandardJavadocDocletOptions excludeDocFilesSubDir(List<String> excludeDocFilesSubDir)
      Exclude doc files sub dir.
      Since:
      0.7

    • excludeDocFilesSubDir

      public StandardJavadocDocletOptions excludeDocFilesSubDir(String... excludeDocFilesSubDir)
      Exclude doc files sub dir.
      Since:
      0.7

    • getNoQualifiers

      @Optional @Input public @Nullable List<String> getNoQualifiers()
      -noqualifier all | packagename1:packagename2:...
      Since:
      0.7

    • setNoQualifiers

      public void setNoQualifiers(@Nullable List<String> noQualifiers)
      Sets the no qualifiers.
      Since:
      0.7

    • noQualifier

      public StandardJavadocDocletOptions noQualifier(List<String> noQualifiers)
      No qualifier.
      Since:
      0.7

    • noQualifiers

      public StandardJavadocDocletOptions noQualifiers(String... noQualifiers)
      No qualifiers.
      Since:
      0.7

    • isNoTimestamp

      @Input public boolean isNoTimestamp()
      Returns whether no timestamp is set.
      Since:
      0.7

    • setNoTimestamp

      public void setNoTimestamp(boolean noTimestamp)
      Sets the no timestamp.
      Since:
      0.7

    • noTimestamp

      public StandardJavadocDocletOptions noTimestamp(boolean noTimestamp)
      No timestamp.
      Since:
      0.7

    • noTimestamp

      public StandardJavadocDocletOptions noTimestamp()
      No timestamp.
      Since:
      0.7

    • isNoComment

      @Input public boolean isNoComment()
      -nocomment.
      Since:
      0.7

    • setNoComment

      public void setNoComment(boolean noComment)
      Sets the no comment.
      Since:
      0.7

    • noComment

      public StandardJavadocDocletOptions noComment(boolean noComment)
      No comment.
      Since:
      0.7

    • noComment

      public StandardJavadocDocletOptions noComment()
      No comment.
      Since:
      0.7