Javadoc/Javadoc2

Javadoc/Javadoc2

Description

Generates code documentation using the javadoc tool.

The source directory will be recursively scanned for Java source files to processbut only those matching the inclusion rules, and not matching the exclusions ruleswill be passed to the javadoc tool. Thisallows wildcards to be used to choose between package names, reducing verbosityand management costs over time. This task, however, has no notion of"changed" files, unlike the javac task. This meansall packages will be processed each time this task is run. In general, however,this task is used much less frequently.

NOTE: since javadoc calls System.exit(), javadoc cannot be run inside thesame VM as Apache Ant without breaking functionality. For this reason, this taskalways forks the VM. This overhead is not significant since javadoc is normally a heavyapplication and will be called infrequently.

NOTE: the packagelist attribute allows you to specify the list of packages todocument outside of the Ant file. It's a much better practice to include everythinginside the build.xml file. This option was added in order to make it easier tomigrate from regular makefiles, where you would use this option of javadoc.The packages listed in packagelist are not checked, so the task performs evenif some packages are missing or broken. Use this option if you wish to convert froman existing makefile. Once things are running you should then switch to the regularnotation.

DEPRECATION: the javadoc2 task simply points to the javadoc task and it'sthere for back compatibility reasons. Since this task will be removed in futureversions, you are strongly encouraged to use javadocinstead.

In the table below, 1.2 means available if your current Java VM isa 1.2 VM (but not 1.3 or later), 1.4+ for any VM of at least version 1.4, otherwiseany VM of at least version 1.2 is acceptable. JDKs <1.4 are no longer supported.If you specify the executable attribute it is up to youto ensure that this command supports the attributes you wish to use.

Note:
When generating the JavaDocs for classes which contains annotationsyou maybe get a java.lang.ClassCastException: com.sun.tools.javadoc.ClassDocImpl.This is due bug-6442982. The cause is that JavaDoc cannot find the implementations of used annotations.The workaround is providing the jars with these implementations (like JAXBs @XmlType, ...)to <javadoc> using classpath, classpathref attributes or nested<classpath> element.

Note: many problems with running javadoc stem from command lines that have become too long - even though the error message doesn't give the slightest hint this may be the problem. If you encounter problems with the task, try to set the useexternalfile attribute to true first.

If you use multiple ways to specify where javadoc should be looking for sources your result will be the union of all specified documentations. If you, e.g., specify a sourcepath attribute and also a nested packageset both pointing at the same directory your excludepackagenames attribute won't have any effect unless it agrees with the exclude patterns of the packageset (and vice versa).

Parameters

Format of the group attribute

The arguments are comma-delimited. Each single argument is 2space-delimited strings, where the first one is the group's title andthe second one a colon delimited list of packages.

If you need to specify more than one group, or a group whose titlecontains a comma or a space character, using nested group elements is highlyrecommended.

E.g.:

 group="XSLT_Packages org.apache.xalan.xslt*,XPath_Packages org.apache.xalan.xpath*"

Parameters specified as nested elements

packageset

A DirSet. All matcheddirectories that contain Java source files will be passed to javadocas package names. Package names are created from the directory namesby translating the directory separator into dots. Ant assumes thebase directory of the packageset points to the root of a packagehierarchy.

The packagenames, excludepackagenames anddefaultexcludes attributes of the task have no effect onthe nested <packageset> elements.

fileset

A FileSet. All matchedfiles will be passed to javadoc as source files. Ant willautomatically add the include pattern **/*.java (and**/package.html if includenosourcepackages is true) tothese filesets.

Nested filesets can be used to document sources that are in thedefault package or if you want to exclude certain files fromdocumentation. If you want to document all source files and don't usethe default package, packagesets should be used instead as thisincreases javadocs performance.

The packagenames, excludepackagenames anddefaultexcludes attributes of the task have no effect onthe nested <fileset> elements.

sourcefiles

A container for arbitrary file system based resourcecollections. All files contained in any of the nested collections(this includes nested filesets, filelists or paths) will be passed tojavadoc as source files.

package

Same as one entry in the list given by packagenames.

Parameters

excludepackage

Same as one entry in the list given by excludepackagenames.

Parameters

source

Same as one entry in the list given by sourcefiles.

Parameters

doctitle

Same as the doctitle attribute, but you can nest textinside the element this way.

If the nested text contains line breaks, you must use the useexternalfile attribute and set it to true.

header

Similar to <doctitle>.

footer

Similar to <doctitle>.

bottom

Similar to <doctitle>.

link

Create link to javadoc output at the given URL. This performs thesame role as the link and linkoffline attributes. You can use eithersyntax (or both at once), but with the nested elements you can easilyspecify multiple occurrences of the arguments.

Parameters

group

Separates packages on the overview page into whatever groups youspecify, one group per table. This performs the same role as the groupattribute. You can use either syntax (or both at once), but with thenested elements you can easily specify multiple occurrences of thearguments.

Parameters

The title may be specified as a nested <title> elementwith text contents, and the packages may be listed with nested<package> elements as for the main task.

doclet

The doclet nested element is used to specify thedocletthat javadoc will use to process the input source files. A number of the standard javadoc argumentsare actually arguments of the standard doclet. If these are specified in the javadoctask's attributes, they will be passed to the doclet specified in the<doclet> nested element. Such attributes should only be specified,therefore, if they can be interpreted by the doclet in use.

If the doclet requires additional parameters, these can be specified with<param> elements within the <doclet>element. These parameters are restricted to simple strings. An example usageof the doclet element is shown below:

  <javadoc ... > <doclet name="theDoclet" path="path/to/theDoclet"> <param name="-foo" value="foovalue"/> <param name="-bar" value="barvalue"/> </doclet>  </javadoc>

tag

If you want to specify a standard tag using a nested tag elementbecause you want to determine the order the tags are output, you mustnot set the description attribute for those tags.

Parameters

ejb.bean:t:XDoclet EJB Tagtodo:a:To Do

taglet

The taglet nested element is used to specify custom taglets.

Parameters

sourcepath, classpath and bootclasspath

Javadoc's sourcepath, classpath andbootclasspath attributes are PATH likestructure and can also be set via nested sourcepath,classpath and bootclasspath elementsrespectively.

arg

Use nested <arg> to specify additionalarguments. See Command linearguments. Since Ant 1.6

Example

  <javadoc packagenames="com.dummy.test.*"   sourcepath="src"   excludepackagenames="com.dummy.test.doc-files.*"   defaultexcludes="yes"   destdir="docs/api"   author="true"   version="true"   use="true"   windowtitle="Test API"> <doctitle><![CDATA[<h1>Test</h1>]]></doctitle> <bottom><![CDATA[<i>Copyright &#169; 2000 Dummy Corp. All Rights Reserved.</i>]]></bottom> <tag name="todo" scope="all" description="To do:"/> <group title="Group 1 Packages" packages="com.dummy.test.a*"/> <group title="Group 2 Packages" packages="com.dummy.test.b*:com.dummy.test.c*"/> <link offline="true" href="http://download.oracle.com/javase/6/docs/api/" packagelistLoc="C:mp"/> <link href="http://developer.java.sun.com/developer/products/xml/docs/api/"/>  </javadoc>

is the same as

  <javadoc   destdir="docs/api"   author="true"   version="true"   use="true"   windowtitle="Test API"> <packageset dir="src" defaultexcludes="yes">  <include name="com/dummy/test/**"/>  <exclude name="com/dummy/test/doc-files/**"/> </packageset> <doctitle><![CDATA[<h1>Test</h1>]]></doctitle> <bottom><![CDATA[<i>Copyright &#169; 2000 Dummy Corp. All Rights Reserved.</i>]]></bottom> <tag name="todo" scope="all" description="To do:"/> <group title="Group 1 Packages" packages="com.dummy.test.a*"/> <group title="Group 2 Packages" packages="com.dummy.test.b*:com.dummy.test.c*"/> <link offline="true" href="http://download.oracle.com/javase/6/docs/api/" packagelistLoc="C:mp"/> <link href="http://developer.java.sun.com/developer/products/xml/docs/api/"/>  </javadoc>

or

  <javadoc   destdir="docs/api"   author="true"   version="true"   use="true"   windowtitle="Test API"> <fileset dir="src" defaultexcludes="yes">  <include name="com/dummy/test/**"/>  <exclude name="com/dummy/test/doc-files/**"/> </fileset> <doctitle><![CDATA[<h1>Test</h1>]]></doctitle> <bottom><![CDATA[<i>Copyright &#169; 2000 Dummy Corp. All Rights Reserved.</i>]]></bottom> <tag name="todo" scope="all" description="To do:"/> <group title="Group 1 Packages" packages="com.dummy.test.a*"/> <group title="Group 2 Packages" packages="com.dummy.test.b*:com.dummy.test.c*"/> <link offline="true" href="http://download.oracle.com/javase/6/docs/api/" packagelistLoc="C:mp"/> <link href="http://developer.java.sun.com/developer/products/xml/docs/api/"/>  </javadoc>