Given below is an example javadoc task used in our project. Let us add a documentation target to our Fax application project. Let us continue our theme of the Hello world Fax application. You could also group the packages together using the group attribute, so that it becomes easy to navigate. You could also tell the javadoc task to include the author and version information using the respective attributes. This is achieved by using the private, public, package and protected attributes. You could filter the javadoc process to show only the public, private, package, or protected classes and members. This is achieved by using the packagenames attribute, a comma separated list of package files.

You could filter the javadoc task by specifying the package names to be included. Sourcefiles is used when you want to specify the individual files as a comma separated list.ĭestination path is specified using the destdir folder (e.g build.dir). Sourcepathref is used to refer a path that is referenced by the path attribute (e.g, ). Sourcepath is used to point to the folder of the source files (e.g. Source can be specified using sourcepath, sourcepathref or sourcefiles. The following section lists the most commonly used javadoc options that are used in Ant. If you are unfamiliar with javadocs, we suggest that you start with this Ant exposes these configuration options via the javadoc task.

Ant makes it even easier by generating the documentation on demand.Īs you know, the javadoc tool is highly flexible and allows a number of configuration options. Java makes documentation easier by the use of the in-built javadoc tool. Documentation plays a great role in the maintenance of a project.

Apache ant doc