Javadoc pre v1.4. Notes may be applicable to later versions, but untested.
Oddities | Go to top
First, some oddities: In your Javadoc comments you must not have a * before an @ (that precedes a Javadoc tag) otherwise the tag will not be recognised. Also, there must not be a full stop at the end of the @param line. For example, the following will NOT work:
/**
* The description of the method.
*
* @param var The description of var.
*/
This will work:
/**
* The description of the method.
*
@param var The description of var.
*/
Finally, remember that you must have your source code in a directory structure that mirrors the package in which the classes belong. E.g. If you have classes in the package com.steph.code then the source code must reside in com/steph/code.
Commands | Go to top
javadoc -d destination packages classes will write Java documentation for packages packages (e.g. com.opencms.modules.roundabout.useradminmodule) and classes (e.g. /store/src/com/opencms/modules/roundabout/useradminmodule/UserAdmin.java) that are located somewhere in your CLASSPATH environment variable and place the results into the destination directory.
javadoc -d destination -sourcepath path -subpackages package will write Java documentation for package package (e.g. com) located at path path and place the results into the destination directory.
