Java Reference
In-Depth Information
Figure 5.1
Javadoc documentation viewed in Konqueror Web browser
-protected
Causes public and protected classes, members, and methods to be docu-
mented.
This is the default documentation level.
This is also the most likely
level at which you would want to document code meant for distribution.
-package
We suspect you can see where this is going. This switch causes package,
protected, and public classes, members, and methods to be documented.
-private
This switch causes all classes, members, and methods to be documented.
In our experience, this is the setting you will want to use for internal
projects. It documents everything.
-sourcepath
and
-classpath
These are the paths that will be searched for source classes or referenced
classes. These switches work like the corresponding switches for the
javac
compiler.
