Java™ Application Development on Linux - Dator

126Chapter 5The Sun Microsystems Java Software <strong>Development</strong> Kit-verbose and -quietThese switches control how much output is produced as javadoc runs. Ifyou choose -verbose, detailed information is produced (more than thedefault; in current versions, this option mostly shows time measurementsof the parsing of each source file). If you choose the -quiet option,progress messages are suppressed completely.-doclet starting_classWe’re not going to go into too much detail on this, but this switch allowsyou to name a doclet (a class that uses the Doclet API) to use in place ofthe default doclet. See the next paragraph for more information.All of the switches documented so far are provided by the javadoc programitself. Javadoc, like the rest of the Sun Microsystems Java SDK, is written inJava. The authors of javadoc took advantage of this. The default behavior ofjavadoc is to produce HTML documentation with a standard look and feel.However, there exists an API, called the Doclet API, which allows you to writea Java class of your own to process the information parsed out of the source byjavadoc. For details, see the Doclet Overview 3 on Sun’s Web site.Sun provides a default doclet that produces HTML documentation. Thatdoclet takes a number of command-line options as well. We’ll cover the mostimportant of those now. Remember, these are provided by the standard doclet.If you use the -doclet switch, then these switches will not be available (unless,of course, the alternate doclet just happens to provide them).-d directoryBy default, the HTML documentation is saved in the same directory asthe source. Use this switch to specify an alternate directory into whichdocumentation is to be placed.-useCauses javadoc to generate a “Use” page for each class and package. Sucha page is a cross-reference to all uses of the class or package.-versionCauses any @version tag data to be included in the documentation. Ifyou are using CVS for source control (and why wouldn’t you?) we3. http://java.sun.com/j2se/1.4.1/docs/tooldocs/javadoc/overview.html