Attribute | Description | Required |
destdir | Destination directory for output files | Yes |
sourcepath | Specify where to find source files | At least one of the three or nested variants |
sourcepathref | Specify where to find source files by reference to a PATH defined elsewhere. | |
argfile | path to file containing line-delimited list of source files. (see also nested variants) | |
sourcefiles | Comma separated list of source files (see also nested variants) | at least one of the three |
packagenames | Comma-separated list of package (may have terminating wildcard) | |
packageList | The name of a file containing the packages to process | |
classpath | Where to find class files for compiling sources | No |
Bootclasspath | Override location of class files loaded by the bootstrap class loader | No |
classpathref | Specify where to find user class files by reference to a PATH defined elsewhere. | No |
bootclasspathref | Override location of class files loaded by the bootstrap class loader by reference to a PATH defined elsewhere. | No |
Extdirs | Override location of installed extensions | No |
Overview | Read overview documentation from HTML file | No |
Public | Show only public classes and members | No |
Protected | Show protected/public classes and members (default) | No |
Package | Show package/protected/public classes and members | No |
Private | Show all classes and members | No |
Verbose | Output messages about what Javadoc is doing | No |
Locale | Locale to be used, e.g. en_US or en_US_WIN | No |
Encoding | Source file encoding name | No |
Version | Include @version paragraphs | No |
Use | Create class and package usage pages | No |
Author | Include @author paragraphs | No |
Splitindex | Split index into one file per letter | No |
Windowtitle | Browser window title for the documentation (text) | No |
Doctitle | Include title for the package index(first) page (html-code) | No |
Header | Include header text for each page (html-code) | No |
Footer | Include footer text for each page (html-code) | No |
bottom | Include bottom text for each page (html-code) | No |
link | Create links to javadoc output at the given URL | No |
linkoffline | Link to docs at <url> using package list at <url2> | No |
group | Group specified packages together in overview page | No |
nodeprecated | Do not include @deprecated information | No |
nodeprecatedlist | Do not generate deprecated list | No |
notree | Do not generate class hierarchy | No |
noindex | Do not generate index | No |
nohelp | Do not generate help link | No |
nonavbar | Do not generate navigation bar | No |
serialwarn | FUTURE: Generate warning about @serial tag | No |
helpfile | Specifies the HTML help file to use | No |
stylesheetfile | Specifies the CSS stylesheet to use | No |
charset | FUTURE: Charset for cross-platform viewing of generated documentation | No |
docencoding | Output file encoding name | No |
additionalparam | Lets you add additional parameters to the javadoc command line. Useful for doclets. Parameters containing spaces need to be quoted using ". | No |
failonerror | Stop the buildprocess if the command exits with a returncode other than 0. | No |
standard | Use the standard doclet to generate files; default to false. | No |
argfiles is a nested element that takes nested path elements to create a list of argument files.
The ajdoc task uses the same nested parameters as the Javadoc task, so please refer to the Javadoc page for a complete listing of these parameters.
The following example documents the packages and sub-packages in org.aspectj found in source path ${src.dir}to directory ${dest.dir} using the Ajdoc tool:
<ajdoc srcdir="${src.dir}
destdir="${dest.dir}
packagenames="org.aspectj.*"
/>
This example uses the argument file files.lst to specify the source files to document, and it documents all members, (i.e., those with private or more access).
<ajdoc srcdir="${src.dir}
destdir="${dest.dir}
private="on"
argfile="files.lst"
/>