xyz.jar, and debug information is on.
Only files under mypackage/p1 and mypackage/p2 are
used. Files in the mypackage/p1/testpackage directory are excluded
form compilation and copy.
+
Generates code documentation using the javadoc tool.
-The source directory will be recursively scanned for Java source files to but -only those matching the inclusion rules will be passed to the javadoc tool. This +
The source directory will be recursively scanned for Java source files to process +but only those matching the inclusion rules will be passed to the javadoc tool. This allows wildcards to be used to choose between package names, reducing verbosity and management costs over time. This task, however, has no notion of -"changed" files, unlike the javac task, but it's -not used so frequently.
+"changed" files, unlike the javac task. This means +all packages will be processed each time this task is run. In general, however, +this task is used much less frequently.This task works seamlessly between different javadoc versions (1.1 and 1.2), with the obvious restriction that the 1.2 attributes will be ignored if run in a 1.1 VM.
-NOTE: since javadoc calls System.exit(), we cannot run javadoc inside the -same VM without breaking functionality. For this reason, this task always forks -the VM. But this is not a performance penalty since javadoc is normally a heavy -application and must be called just once.
+NOTE: since javadoc calls System.exit(), javadoc cannot be run inside the +same VM as ant without breaking functionality. For this reason, this task +always forks the VM. This overhead is not significant since javadoc is normally a heavy +application and will be called infrequently.
+NOTE: the packagelist attribute allows you to specify the list of packages to +document outside of the Ant file. It's a much better practice to include everything +inside the build.xml file. This option was added in order to make it easier to +migrate from regular makefiles, where you would use this option of javadoc. +The packages listed in packagelist are not checked, so the task performs even +if some packages are missing or broken. Use this option if you wish to convert from +an existing makefile. Once things are running you should then switch to the regular +notation. +
DEPRECATION: the javadoc2 task simply points to the javadoc task and it's there for back compatibility reasons. Since this task will be removed in future versions, you are strongly encouraged to use javadoc @@ -1701,6 +1713,12 @@ instead.
| Attribute | +Description | +Required | +
| href | +The URL for the external documentation you wish to link to | +Yes | +
| offline | +True if this link is not available online at the time of + generating the documentation | No |
| packagelistLoc | +The location to the directory containing the package-list file for + the external documentation | +Only if the offline attribute is true | +
| Attribute | +Description | +Required | +
| title | +Title of the group | +Yes | +
| packages | +List of packages to include in that group | +Yes | +
<javadoc packagenames="com.dummy.test.*"
sourcepath="src"
@@ -1946,8 +2037,13 @@ instead.
use="true"
windowtitle="Test API"
doctitle="<h1>Test</h1>"
- bottom="<i>Copyright © 2000 Dummy Corp. All Rights Reserved.</i>"
- />
+ bottom="<i>Copyright © 2000 Dummy Corp. All Rights Reserved.</i>">
+ <group title="Group 1 Packages" packages="com.dummy.test.a*"/>
+ <group title="Group 2 Packages" packages="com.dummy.test.b*"/>
+ <link offline="true" href="http://java.sun.com/products/jdk/1.2/docs/api/" packagelistLoc="C:\tmp"/>
+ <link href="http://developer.java.sun.com/developer/products/xml/docs/api/"/>
+ </javadoc>
+