How To integrate JUnitDoclet into your favorite development
environment:

First, check this directory for customized integration in your
favorite development environment. If you can't find it, try this.

We tested with:
  IntelliJ IDEA 2.6 on Windows 2000
  IntelliJ IDEA 2.6 on Windows 98
  IntelliJ IDEA 3.0 on Windows 2000
  IntelliJ IDEA 3.0 on Suse 8.1
  Eclipse 2.0.1     on Suse 8.1

Please consider the scripts provided to be a starting point.
As you discover your preferences you will adjust them to your
need. Their goal is, to get you started. Feel free to send
us more advanced scripts if you want to share them.
  

The lowest common denominator:

"run_junitdoclet.bat" and "run_junitdoclet_recursive.bat" are
examples for using JUnitDoclet as external tool.

They are using "run_junitdoclet_setenv.bat" so configure the
environment. All settings are made there.

To process all subpackages and files within them, javadoc needs
a file with the list of those packages. packagelister.jar
does provide a tool to generate that file.

Installation:

  Copy these files to a directory which is part of your PATH.
    run_junitdoclet.bat
    run_junitdoclet_recursive.bat
    run_junitdoclet_setenv.bat
    packagelister.jar
    JUnitDoclet.jar

  Modify the custom settings in run_junitdoclet_setenv.bat
    INSTALL_DIRECTORY should be set to the directory, where
    the files (see above) are located.

    You can set default values which are used, if no
    environment variable is set and the command line
    does not overwrite it.

  Check if the files are in the path and directories are OK.

      d:\bin> cd \projects\demo_project

      d:\projects\demo_project> run_junitdoclet.bat

    Fix any errors as they are reported.

Usage:

This is useful if you mainly work on the command line. Requires
relatively few keystrokes. You may override some parameters by
hand in the order given below. E.g.:

  d:\projects\demo_project> run_junitdoclet.bat "com.xyz" \
                      "./src" "-properties my.properties"

Please write the parameters in this order:
  <PACKAGENAMES_OR_SOURCEFILE>
  <SOURCE_PATH>
  <EXTRA_PARAMS>
  <CLASSPATH>
  <JAVA_HOME>
  <OUTPUT_DIR>
  <DOCLETPATH>

If you don't specify all parameters, the defaults are used.
Defaults can be either environment variables or hard coded
values from run_junitdoclet_setenv.bat (environment
variables overwrite any hard coded value).

More sophisticated editors and IDEs can integrate these
Scripts as external tool.

Miscellaneous:

"run_junitdoclet.sh", "run_junitdoclet_recursive.sh" and
"run_junitdoclet_setenv.sh" are translated into a shell
script. Usage and parameters are the same.
Don't forget to "chmod +rx run_junitdoclet*.sh".

Of course you could configure javadoc with JUnitDoclet
directly as external tool (without intermediate batch file).

