Exclude Doclet

This is a very simple wrapper program that enables you to exclude from the generated documentation any public or protected classes (or packages) that you specify. It takes a list of classes in a file and removes them from the RootDoc before delegating execution to the standard doclet.

Works with JDK 1.4.x and 5.x.

NOTE: Excluding packages is not unique to this doclet. The javadoc tool already has the -exclude option to exclude packages when using the -subpackages option.

Usage

• toolpath - path to ExcludeDoclet.class and the path to tools.jar, separated by a colon (Solaris/Linux) or semi-colon (Windows)
• excludefilepath - path to a file containing class (or package) names you want to exclude, one name per line. The names should be fully qualified. You can write comments in this file by starting the line with a hash (#) character.
• javadoc-options - options, package names and source filenames to pass to the javadoc tool and standard doclet

Example

1. Create a file containing the fully-qualified class names you want to exclude. Any line that begins with a hash (#) characters is a comment.

          C:> more skip.txt
          # Exclude six classes
          java.lang.Math
          java.lang.Long
          java.lang.InternalError 
          java.lang.InterruptedException 
          java.lang.Iterable 
          java.lang.LinkageError 
   

2. Run the Exclude Doclet:

   Given that ExcludeDoclet.class is in the current directory, tools.jar is in C:\jdk1.5.0\lib, and that skip.txt is in the current directory, run the following command (on Windows):

   C:> java -classpath .;C:\jdk1.5.0\lib\tools.jar ExcludeDoclet -excludefile ./skip.txt -d docs -sourcepath C:\j2se\src -source 1.5 java.lang

   This runs javadoc on the java.lang package, excluding the classes specified in skip.txt. It runs on the source files located at c:\j2se\src\java\lang\*.java, and saves the generated HTML files in the .\docs directory. This command prints a list of files it is excluding:

         Removing excluded source files.......
         Excluding com.package1.DeprecatedClass
   

Compile Doclet

If you modify the doclet's source file, you can re-compile it as follows:

C:> javac -classpath tools.jar ExcludeDoclet.java