jgrasp handbook

4.4 Generating Documentation for the Project (Java only)
DRAFT, February 18, 2003, Page 47
Now that you have established a project, you have the option to generate project level documentation for
your Java classes. You can automatically generate documentation in the style of an application
programmer interface (API). To begin the process of generating the documentation, click on the Project
menu as shown in the figure below, and select Generate Documentation. This will bring up the “Generate
Documentation for Project” dialog, which asks for the directory where the generated HTML files are to be
stored. The default directory name is the name of the project with “_doc” appended to it. So for the
example, the default will be PersonalLibaryProject_doc. Using the default name is recommended so that
your documentation directories will have a standard naming convention. However, you are free to use
any directory as the target. After choosing the directory, click Generate to start the process. jGRASP
calls the javadoc utility, included with the J2SDK, to create a complete hyper-linked document within a
few seconds.
Figure 34. Generating Documentation for the Project