You already know how to write comments in your classes using the // and /* … */ notations. These comments serve as documentation that is good mostly for the developer who is writing the class and developers who will continue work on the class. There is another type of documentation in Java. This type is suitable if you are writing API that will be used by other people. This chapter shows how to use the javadoc program to generate Java API documentation.
You use the javadoc program that comes with the JDK and can be found under the bin directory of your JDK installation. By default, javadoc generates HTML files that describe packages and types. Every single HTML file generated describes either a package or a type. Within ...