Namejavadoc---The Java Documentation Generator
JDK 1.0 and later.
javadoc [ options ] packagename javadoc [ options ] filenames
javadoc generates API documentation, in HTML format, for the specified package, or for the individual Java source files specified on the command line.
When a package name is specified on the command line, javadoc looks for a corresponding package directory relative to the class path. It then parses all of the .java source files in that directory and generates an HTML documentation file for each class and an HTML index of the classes in the package. By default, the HTML files are placed in the current directory. The -d option allows you to override this default.
Note that the packagename argument to javadoc is the name of the package (components separated by periods) and not the name of the package directory. You may need to specify the -sourcepath option so that javadoc can find your package source code correctly, if it is not stored in the same location as the package class files.
javadoc may also be invoked with any number of Java source files specified on the command line. Note that these are filenames, not class names, and are specified with any necessary directory components, and with the .java extension. When javadoc is invoked in this way, it reads the specified source files and generates HTML files (in the current directory, by default) that describe each public class defined in the specified source files.
The class documentation files that javadoc generates describe the class (or interface) and its inheritance hierarchy, and index and describe each of the public and protected members of the class. The generated file also contains any "doc comments" that are associated with the class and with its methods, constructors, and variables. A "doc comment," or documentation comment, is a Java comment that begins with /** and ends with */. A doc comment may include any HTML markup tags (although it should not include structuring tags like <H1> or <HR>), and may also include tag values that are treated specially by javadoc. These special tags and their syntax are documented fully in Chapter 13, Java Syntax.
When javadoc cannot find a specified package, it produces a stub HTML file and does not warn you that the package was not found.