<java : Javadoc>

Description

Generates Javadoc documentation for a collection of source code.

Current known limitations are:

If no doclet is set, then the version and author are by default "yes".

Note: This task is run on another VM because the Javadoc code calls System.exit() which would break Ant functionality.

Parameters

Attribute Description Type Required?
bottom Set the text to be placed at the bottom of each output file. String ?
verbose Run javadoc in verbose mode boolean ?
bootclasspathref Adds a reference to a CLASSPATH defined elsewhere. Reference ?
executable Sets the actual executable command to invoke, instead of the binary javadoc found in Ant's JDK. String ?
header Set the header text to be placed at the top of each output file. String ?
link Create links to javadoc output at the given URL. String ?
noindex Control generation of index. boolean ?
access Set the scope to be processed. This is an alternative to the use of the setPublic, setPrivate, etc methods. It gives better build file control over what scope is processed. String ["protected", "public", "package", "private"] ?
doclet Set the class that starts the doclet used in generating the documentation. String ?
noqualifier Enables the -noqualifier switch, will be ignored if javadoc is not the 1.4 version. String ?
author Include the author tag in the generated documentation. boolean ?
public Indicate whether only public classes and members are to be included in the scope processed boolean ?
footer Set the footer text to be placed at the bottom of each output file. String ?
docletpath Set the classpath used to find the doclet class. Path ?
package Indicate whether only package, protected and public classes and members are to be included in the scope processed boolean ?
useexternalfile Work around command line length limit by using an external file for the sourcefiles. boolean ?
sourcepathref Adds a reference to a CLASSPATH defined elsewhere. Reference ?
protected Indicate whether only protected and public classes and members are to be included in the scope processed boolean ?
breakiterator Enables the -linksource switch, will be ignored if javadoc is not the 1.4 version. Default is false boolean ?
nonavbar Control generation of the navigation bar. boolean ?
maxmemory Set the maximum memory to be used by the javadoc process String ?
group Group specified packages together in overview page. String ?
source Enables the -source switch, will be ignored if javadoc is not the 1.4 version. String ?
linkoffline Link to docs at "url" using package list at "url2" - separate the URLs by using a space character. String ?
additionalparam Set an additional parameter on the command line String ?
linksource Enables the -linksource switch, will be ignored if javadoc is not the 1.4 version. Default is false boolean ?
failonerror Should the build process fail if javadoc fails (as indicated by a non zero return code)?

Default is false.

 boolean ?
locale Set the local to use in documentation generation. String ?
destdir Set the directory where the Javadoc output will be generated. File ?
classpath Set the classpath to be used for this javadoc run. Path ?
defaultexcludes Sets whether default exclusions should be used or not. boolean ?
includenosourcepackages If set to true, Ant will also accept packages that only hold package.html files but no Java sources. boolean ?
bootclasspath Set the boot classpath to use. Path ?
private Indicate whether all classes and members are to be included in the scope processed boolean ?
nodeprecatedlist Control deprecated list generation boolean ?
charset Charset for cross-platform viewing of generated documentation. String ?
classpathref Adds a reference to a CLASSPATH defined elsewhere. Reference ?
stylesheetfile Specifies the CSS stylesheet file to use. File ?
docencoding Output file encoding name. String ?
excludepackagenames Set the list of packages to be excluded. String ?
docletpathref Set the classpath used to find the doclet class by reference. Reference ?
packagenames Set the package names to be processed. String ?
windowtitle Set the title to be placed in the HTML <title> tag of the generated documentation. String ?
notree Control class tree generation. boolean ?
splitindex Generate a split index boolean ?
packagelist The name of a file containing the packages to process. String ?
encoding Set the encoding name of the source files, String ?
doctitle Set the title of the generated overview page. String ?
serialwarn Control warnings about serial tag. boolean ?
old Indicate whether Javadoc should produce old style (JDK 1.1) documentation. This is not supported by JDK 1.1 and has been phased out in JDK 1.4 boolean ?
use Generate the "use" page for each package. boolean ?
sourcepath Specify where to find source file Path ?
helpfile Specifies the HTML help file to use. File ?
version Include the version tag in the generated documentation. boolean ?
sourcefiles Set the list of source files to process. String ?
extdirs Set the location of the extensions directories. Path ?
nohelp Control generation of help link. boolean ?
nodeprecated Control deprecation infromation boolean ?
overview Specify the file containing the overview to be included in the generated documentation. File ?

Parameters accepted as nested elements

<taglet> ...

A project aware class used for Javadoc extensions which take a name and a path such as doclet and taglet arguments.
Attribute Description Type Required
name Set the name of the extension String ?
pathref Adds a reference to a CLASSPATH defined elsewhere. Reference ?
path Set the path to use when loading the component. Path ?

<doclet> ...

This class stores info about doclets.
Attribute Description Type Required
name String ?
pathref Reference ?
path Path ?

<package>

Used to track info about the packages to be javadoc'd
Attribute Description Type Required
name Set the name of the package String ?

<arg>

Used for nested xml command line definitions.
Attribute Description Type Required
line Line to split into several commandline arguments. String ?
file Sets a single commandline argument to the absolute filename of the given file. File ?
pathref Sets a single commandline argument from a reference to a path - ensures the right separator for the local platform is used. Reference ?
value Sets a single commandline argument. String ?
path Sets a single commandline argument and treats it like a PATH - ensures the right separator for the local platform is used. Path ?

<link>

Represents a link triplet (href, whether link is offline, location of the package list if off line)
Attribute Description Type Required
href String ?
offline boolean ?
packagelistloc File ?
resolvelink Sets whether Ant should resolve the link attribute relative to the current basedir. boolean ?

<doctitle>

An HTML element in the javadoc. This class is used for those javadoc elements which contain HTML such as footers, headers, etc.
Attribute Description Type Required

<bottom>

An HTML element in the javadoc. This class is used for those javadoc elements which contain HTML such as footers, headers, etc.
Attribute Description Type Required

<group> ...

Attribute Description Type Required
packages String ?
title String ?

<packageset> ...

Subclass as hint for supporting tasks that the included directories instead of files should be used.
Attribute Description Type Required
refid Reference ?
file File ?
dir File ?
defaultexcludes boolean ?
followsymlinks boolean ?
casesensitive boolean ?
excludes String ?
includesfile File ?
excludesfile File ?
includes String ?

<fileset> ...

Moved out of MatchingTask to make it a standalone object that could be referenced (by scripts for example).
Attribute Description Type Required
refid Reference ?
file File ?
dir File ?
defaultexcludes boolean ?
followsymlinks boolean ?
casesensitive boolean ?
excludes String ?
includesfile File ?
excludesfile File ?
includes String ?

<classpath> ...

This object represents a path as used by CLASSPATH or PATH environment variable.

<sometask>
  <somepath>
    <pathelement location="/path/to/file.jar" />
    <pathelement path="/path/to/file2.jar:/path/to/class2;/path/to/class3" />
    <pathelement location="/path/to/file3.jar" />
    <pathelement location="/path/to/file4.jar" />
  </somepath>
</sometask>

The object implemention sometask must provide a method called createSomepath which returns an instance of Path. Nested path definitions are handled by the Path object and must be labeled pathelement.

The path element takes a parameter path which will be parsed and split into single elements. It will usually be used to define a path from an environment variable.

Attribute Description Type Required
refid Makes this instance in effect a reference to another Path instance.

You must not set another attribute or nest elements inside this element if you make it a reference.

 		Reference ?
path Parses a path definition and creates single PathElements. String ?

<sourcepath> ...

This object represents a path as used by CLASSPATH or PATH environment variable.

<sometask>
  <somepath>
    <pathelement location="/path/to/file.jar" />
    <pathelement path="/path/to/file2.jar:/path/to/class2;/path/to/class3" />
    <pathelement location="/path/to/file3.jar" />
    <pathelement location="/path/to/file4.jar" />
  </somepath>
</sometask>

The object implemention sometask must provide a method called createSomepath which returns an instance of Path. Nested path definitions are handled by the Path object and must be labeled pathelement.

The path element takes a parameter path which will be parsed and split into single elements. It will usually be used to define a path from an environment variable.

Attribute Description Type Required
refid Makes this instance in effect a reference to another Path instance.

You must not set another attribute or nest elements inside this element if you make it a reference.

 		Reference ?
path Parses a path definition and creates single PathElements. String ?

<footer>

An HTML element in the javadoc. This class is used for those javadoc elements which contain HTML such as footers, headers, etc.
Attribute Description Type Required

<source>

This class is used to manage the source files to be processed.
Attribute Description Type Required
file Set the source file. File ?

<bootclasspath> ...

This object represents a path as used by CLASSPATH or PATH environment variable.

<sometask>
  <somepath>
    <pathelement location="/path/to/file.jar" />
    <pathelement path="/path/to/file2.jar:/path/to/class2;/path/to/class3" />
    <pathelement location="/path/to/file3.jar" />
    <pathelement location="/path/to/file4.jar" />
  </somepath>
</sometask>

The object implemention sometask must provide a method called createSomepath which returns an instance of Path. Nested path definitions are handled by the Path object and must be labeled pathelement.

The path element takes a parameter path which will be parsed and split into single elements. It will usually be used to define a path from an environment variable.

Attribute Description Type Required
refid Makes this instance in effect a reference to another Path instance.

You must not set another attribute or nest elements inside this element if you make it a reference.

 		Reference ?
path Parses a path definition and creates single PathElements. String ?

<header>

An HTML element in the javadoc. This class is used for those javadoc elements which contain HTML such as footers, headers, etc.
Attribute Description Type Required

<excludepackage>

Used to track info about the packages to be javadoc'd
Attribute Description Type Required
name Set the name of the package String ?

<tag> ...

Class representing a -tag argument.
Attribute Description Type Required
refid Reference ?
name Sets the name of the tag. String ?
file File ?
dir File ?
defaultexcludes boolean ?
followsymlinks boolean ?
enabled Sets whether or not the tag is enabled. boolean ?
casesensitive boolean ?
excludesfile File ?
includesfile File ?
excludes String ?
scope Sets the scope of the tag. This is in comma-separated form, with each element being one of "all" (the default), "overview", "packages", "types", "constructors", "methods", "fields". The elements are treated in a case-insensitive manner. String ?
includes String ?

Generated with AntDoclet