How do I run Javadoc?
There are two ways to run Javadoc — on classes and on packages. The examples at the end of the Javadoc Tool Reference Doc describes both ways: • Javadoc 1.4 Solaris Examples • Javadoc 1.4 Microsoft Windows Examples Javadoc 1.1 has some important bugs, so if using that version, it is imperative to read the Javadoc 1.1 Only section of this FAQ. Also, Javadoc uses parts of the Java Compiler (javac) to parse through the source code. It is therefore simplest if you run Javadoc on the .java source files in the same directory hierarchy as they are in when you compile. Once you’ve run Javadoc and want to view the generated HTML, the topmost page is named index.html (or packages.html in Javadoc 1.1).
• In the Package Explorer window, choose the package or file for which you want to generate documentation. • Choose Project -> Generate Javadoc…, or choose File -> Export… -> Javadoc -> Next> • If the dialog box displays the message The Javadoc command does not exist, then you need to click the Configure… button and locate javadoc.exe. You already have this file: • Windows: C:\Program Files\Java\j2sdk1.5.0\bin\javadoc.exe, (or something similar) • Macintosh: System/Library/Frameworks/JavaVM.framework/Versions/1.5.0/Commands/javadoc • Select the project from the list of currently open projects, and select the destination for the javadoc files. • Select the level of documentation (public through private). Other people should usually just see documentation for your public fields and methods, but you may want more extensive documentation for your own use. • If you have no assert statements, you can click Finish at this point. • Click Next > • Click Next > • Set JRE source compatibili
