The default directory name is the project name with

Info iconThis preview shows page 1. Sign up to view the full content.

View Full Document Right Arrow Icon
This is the end of the preview. Sign up to access the rest of the document.

Unformatted text preview: HTML files are to be stored. The default directory name is the project name with “_doc” appended to it (e.g., PersonalLibaryProject_doc). Using the default name is recommended so that your documentation directories will have a standard naming convention. If the default directory is not indicated, click the Default button in the dialog. However, you are free to use any directory as the target. Click the Generate button on the dialog to start the process. jGRASP calls the javadoc utility, which is included with the JDK, to create a complete hyper-linked document. Figure 7-5. Generating Documentation for the Project 7-6 Projects (1.8.7) 9/2/2009 The documentation generated for PersonalLibaryProject is shown below in Figure 7-6. Note that in this example, even though no JavaDoc comments were included in the source file, the generated documentation is still quite useful. However, for even better documentation, JavaDoc formal comments should be included in the source code. When generated for a project, the documentation files are stored in a directory that becomes part of the project and, therefore, persists from...
View Full Document

This note was uploaded on 07/16/2012 for the course COMP 1210 taught by Professor Cross during the Spring '07 term at Auburn University.

Ask a homework question - tutors are online