K.4. javadoc

In this section, we discuss how to execute the javadoc tool on a Java source file to create HTML documentation for the class in the file. Like other tools, javadoc is executed from the command line. The general form of the javadoc command is

javadoc options packages sources @files

where options is a list of command-line options, packages is a list of packages the user would like to document, sources is a list of java source files to document and @files is a list of text files containing the javadoc options, the names of packages and/or source files to send to the javadoc utility. [Note: All items are separated by spaces and @files is one word.] Figure K.7 shows a Command Prompt window containing the javadoc command we typed to ...

Get Java™ How to Program, Seventh Edition now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.