Decorator for creating HTML Javadoc documentation.
| Task package: | org.schmant.task.base |
| Java package: | org.schmant.task.jdk.javadoc.ext |
| Category: | Documentation tasks |
| Since: | 0.5 |
| EntityFS-aware? | No* |
| See also: | ExtJavadocTF ExtPdfDocletDecorator |
Description:
Decorator used together with ExtJavadocTF to create HTML Javadoc documentation.
Required properties
Properties
| author | top |
Include the text from the @author tag in the
generated documentation?
This corresponds to the standard doclet's -author argument. See
the standard doclet documentation for more details.
- Setter method:
setAuthor(boolean b)
parameters:b– Should author information be included?- Default value:
false(author information is not included)
| bottom | top |
The text placed at the bottom of each generated HTML file.
This corresponds to the standard doclet's -bottom argument. See
the standard doclet documentation for more details.
| charset | top |
The HTML character set for the generated documentation
This corresponds to the standard doclet's -charset argument. See
the standard doclet documentation for more details.
- Setter method:
setCharset(String name)
parameters:name– The name of the charset. The name should be a preferred MIME name, such as "iso-8859-1" or "utf-8".- See also:
- docEncoding
| docEncoding | top |
The encoding of the generated HTML files. If this is not
set, the value of the Javadoc task's encoding property will be used.
This corresponds to the standard doclet's -docencoding argument. See
the standard doclet documentation for more details.
- Setter method:
setDocEncoding(String name)
parameters:name– The MIME name of the encoding of the generated HTML files.- See also:
- charset
| docFilesSubdirs | top |
Enables deep copying of doc-files directories.
This corresponds to the standard doclet's -docfilessubdirs argument. See
the standard doclet documentation for more details.
- Setter method:
setDocFilesSubdirs(boolean b)
parameters:b– Should deep copying be enabled?- Default value:
false(deep copying of doc files subdirectories is disabled)- See also:
- excludeDocFilesSubdirs
| docTitle | top |
The title for the overview page.
This corresponds to the standard doclet's -doctitle argument. See
the standard doclet documentation for more details.
- Setter method:
setDocTitle(String s)
parameters:s– The overview page title.- See also:
- windowTitle
| excludeDocFilesSubdirs | top |
A collection of names of doc-files directories that should be excluded from the copying if docFilesSubdirs is set.
This corresponds to the standard doclet's -excludedocfilessubdirs argument. See
the standard doclet documentation for more details.
- Setter method:
addExcludeDocFilesSubdir(String name)Add one subdirectory to exclude.parameters:name– The name of a subdirectory to exclude.- Setter method:
addExcludeDocFilesSubdirs(Object o)Add one or several names of subdirectories to exclude.parameters:o– One name or an array or collection of names of subdirectories to exclude.- See also:
- docFilesSubdirs
| footer | top |
The footer text for each generated HTML file.
This corresponds to the standard doclet's -footer argument. See
the standard doclet documentation for more details.
| groups | top |
A collection of Java package patterns used to separate different package categories on the documentation's overview page.
This corresponds to the standard doclet's -group argument. See
the standard doclet documentation for more details.
- Setter method:
addGroup(String heading, String patternList)Add one package group.parameters:heading– The package group heading that should be written on the overview page.patternList– A colon- or semicolon-separated list of package names or patterns that matches the names of the packages to include in the group. See the standard doclet documentation for the format of this string.- Setter method:
addGroup(JavadocPackageGroup g)Add one package group.parameters:g– A package group.- Setter method:
addGroups(Object o)Add one or several package groups.parameters:o– One package group or an array or collection of package groups (strings).
| header | top |
The header text for each generated HTML file.
This corresponds to the standard doclet's -header argument. See
the standard doclet documentation for more details.
| helpFile | top |
Set an alternate help file that the top and bottom navigation bars link to.
This corresponds to the standard doclet's -helpfile argument. See
the standard doclet documentation for more details.
- Setter method:
setHelpFile(Object o)
parameters:
| keywords | top |
Add HTML meta keyword tags to the generated documentation file for each class?
This corresponds to the standard doclet's -keywords argument. See
the standard doclet documentation for more details.
- Setter method:
setKeywords(boolean b)
parameters:b– Should keywords meta information be added to class documentation files?- Default value:
false(keyword meta tags are not generated)
| linkoffline | top |
A collection of links to existing Javadoc documentation for external referenced classes. This is used over link when the Javadoc tool is run offline.
This corresponds to the standard doclet's -linkoffline argument. See
the standard doclet documentation for more details.
- Setter method:
addOfflineLink(String l)Add one external Javadoc link.parameters:l– A URL referencing external Javadoc documentation.- Setter method:
addOfflineLinks(Object o)Add one or several external Javadoc links.parameters:o– One documentation link or an array or collection of URL:s for external Javadoc documentation links.- See also:
- links
| links | top |
A collection of links to existing Javadoc documentation for external referenced classes.
This corresponds to the standard doclet's -link argument. See
the standard doclet documentation for more details.
- Setter method:
addLink(String l)Add one external Javadoc link.parameters:l– A URL referencing external Javadoc documentation.- Setter method:
addLinks(Object o)Add one or several external Javadoc links.parameters:o– One link or an array or collection of URL:s for external Javadoc documentation links.- See also:
- linkoffline
| linkSource | top |
Create an HTML version of all documented Java files and link to them from the Javadoc documentation?
This corresponds to the standard doclet's -linksource argument. See
the standard doclet documentation for more details.
- Setter method:
setLinkSource(boolean b)
parameters:b– Should HTML source files be generated for each documented Java file?- Default value:
false(HTML source files are not generated)
| noComment | top |
Don't include the main comment body at all in generated HTML files.
This corresponds to the standard doclet's -nocomment argument. See
the standard doclet documentation for more details.
- Setter method:
disableComment(boolean b)
parameters:b– Should the entire comment body be omitted?- Default value:
false(the comment body is included)
| noDeprecated | top |
Do not include deprecated items in the documentation.
This corresponds to the standard doclet's -nodeprecated argument. See
the standard doclet documentation for more details.
- Setter method:
disableDeprecated(boolean b)
parameters:b– Should documentation on deprecated items be omitted?- Default value:
false(documentation on deprecated items is included)- See also:
- noDeprecatedList
| noDeprecatedList | top |
Don't generate the file with the deprecated API items.
This corresponds to the standard doclet's -nodeprecatedlist argument. See
the standard doclet documentation for more details.
- Setter method:
disableDeprecatedList(boolean b)
parameters:b– Should the generation of the deprecated list be disabled?- Default value:
false(a list of deprecated items is generated)- See also:
- noDeprecated
| noHelp | top |
Should the HELP link in the navigation bar be omitted?
This corresponds to the standard doclet's -nohelp argument. See
the standard doclet documentation for more details.
- Setter method:
disableHelp(boolean b)
parameters:b– Should the HELP link be disabled?- Default value:
false(a HELP link is created)
| noIndex | top |
Don't generate an index for the documentation.
This corresponds to the standard doclet's -noindex argument. See
the standard doclet documentation for more details.
- Setter method:
disableIndex(boolean b)
parameters:b– Should the index page not be generated?- Default value:
false(an index page is generated)
| noNavbar | top |
Should the navigation bars at the top and bottom of the generated pages be omitted?
This corresponds to the standard doclet's -nonavbar argument. See
the standard doclet documentation for more details.
- Setter method:
disableNavbar(boolean b)
parameters:b– Should the navigation bars be omitted?- Default value:
false(navigation bars are created)
| noQualifierPackages | top |
A collection of package names of packages that should be
omitted from class names in the output. Set to all to omit all
packages.
This corresponds to the standard doclet's -noqualifier argument. See
the standard doclet documentation for more details.
- Setter method:
addNoQualifierPackage(String name)Add one name of a package that should not be qualified in the documentation.parameters:name– The name of a package.- Setter method:
addNoQualifierPackages(Object o)Add one or several names of packages that should not be qualified in the documentation.parameters:o– One name or an array or collection of package names.
| noSince | top |
Don't include the data from the @since tags
in the documentation.
This corresponds to the standard doclet's -nosince argument. See
the standard doclet documentation for more details.
- Setter method:
disableSince(boolean b)
parameters:b– Should the generation of@sincedocumentation be disabled?- Default value:
false(@sincedocumentation is included)
| noTimestamp | top |
Don't include a timestamp in a hidden HTML comment in each generated documentation file.
This corresponds to the standard doclet's -notimestamp argument. See
the standard doclet documentation for more details.
- Setter method:
disableTimestamp(boolean b)
parameters:b– Should the timestamp be disabled?- Default value:
false(a timestamp is included in each generated HTML file)
| noTree | top |
Don't include class/interface hierarchy pages in the generated documentation.
This corresponds to the standard doclet's -notree argument. See
the standard doclet documentation for more details.
- Setter method:
disableTree(boolean b)
parameters:b– Should hierarchy tree documentation be disabled?- Default value:
false(hierarchy tree documentation is included)
| serialWarn | top |
Warn if @serial tags are missing?
This corresponds to the standard doclet's -serialwarn argument. See
the standard doclet documentation for more details.
- Setter method:
setSerialWarn(boolean b)
parameters:b– Should serial warnings be enabled?- Default value:
false(@serialwarnings are disabled.
| splitIndex | top |
Split the index file into multiple files, alphabetically, one file per letter?
This corresponds to the standard doclet's -splitindex argument. See
the standard doclet documentation for more details.
- Setter method:
setSplitIndex(boolean b)
parameters:b– Should the index file be split into multiple files?- Default value:
false(the index file is not split)
| stylesheetFile | top |
Set an alternate CSS stylesheet file for the generated documentation.
This corresponds to the standard doclet's -stylesheetfile argument. See
the standard doclet documentation for more details.
- Setter method:
setStylesheetFile(Object o)
parameters:
| target (required) | top |
Target directory for the generated documentation.
This corresponds to the standard doclet's -d argument. See
the standard doclet documentation for more details.
- Setter method:
setTarget(Object o)
parameters:o– The directory to put the Javadoc documentation in.
Interpreted byInterpretAsFutureEntityStrategy.
| use | top |
Should an "use" page be created for each class and interface?
This corresponds to the standard doclet's -use argument. See
the standard doclet documentation for more details.
- Setter method:
setUse(boolean b)
parameters:b– Should "use" pages be generated?- Default value:
false("use" pages are not generated)
| version | top |
Include the text from the @version tag in the
generated documentation?
This corresponds to the standard doclet's -version argument. See
the standard doclet documentation for more details.
- Setter method:
setVersion(boolean b)
parameters:b– Should version information be included?- Default value:
false(the version information is not included)
| windowTitle | top |
The title of the browser window viewing the documentation.
This corresponds to the standard doclet's -windowtitle argument. See
the standard doclet documentation for more details.
- Setter method:
setWindowTitle(String s)
parameters:s– The window title.- See also:
- docTitle
Examples
See ExtJavadocTF for usage examples.* That a task is not EntityFS-aware means that it is not aware of DirectoryView filters (it uses them as plain Directory:s) and also that it usually requires that the entities it takes as arguments are in a File-based file file system. (That they are ECFileResolvable.) A non File-resolvable entity can be made so by using the SchmantFileSystems.makeFileResolvable(org.entityfs.EFile) method.