Java Reference
In-Depth Information
WecanextractthesedocumentationcommentsintoasetofHTMLfilesbyusingthe
JDK's javadoc tool, as follows:
javadoc -private HelloWorld.java
javadoc defaults to generating HTML-based documentation for public classes
and public / protected members of these classes—you'll learn about these con-
cepts in Chapter 2 . Because HelloWorld is not public , specifying javadoc
HelloWorld.java causes javadoc tocomplainthatno public or protected
classes were found to document. The remedy is to specify javadoc 's -private
command-line option.
javadoc responds by outputting the following messages:
Loading source file HelloWorld.java...
Constructing Javadoc information...
Standard Doclet version 1.7.0
Building tree for all the packages and classes...
Generating \HelloWorld.html...
Generating \package-frame.html...
Generating \package-summary.html...
Generating \package-tree.html...
Generating \constant-values.html...
Building index for all the packages and classes...
Generating \overview-tree.html...
Generating \index-all.html...
Generating \deprecated-list.html...
Building index for all classes...
Generating \allclasses-frame.html...
Generating \allclasses-noframe.html...
Generating \index.html...
Generating \help-doc.html...
Italsogeneratesseveralfiles,includingthe index.html entry-pointfile.Pointyour
browser to this file and you should see a page similar to that shown in Figure 1-4 .
Search WWH ::




Custom Search