15.07.2013 Views

jgrasp handbook

jgrasp handbook

jgrasp handbook

SHOW MORE
SHOW LESS

You also want an ePaper? Increase the reach of your titles

YUMPU automatically turns print PDFs into web optimized ePapers that Google loves.

DRAFT, February 18, 2003, Page 48<br />

This can be done on a file-by-file basis or for a complete project as shown in Figure 35 below. Note, in<br />

this example, even though no JavaDoc comments were included in the source file, the generated<br />

documentation is still quite useful. However, for even more useful results, JavaDoc formal comments<br />

should be included in the source code. When the documentation is generated for an individual file, it is<br />

stored in a temporary directory for the duration of the jGRASP session. When generated for a project, the<br />

documentation files are stored in a directory that becomes part of the project, and therefore, persists from<br />

one jGRASP session to the next. If any changes are made to a project source file (and the file is<br />

resaved), jGRASP will indicate that the documentation needs to be regenerated; however, the user may<br />

choose to view the documentation files without updating them.<br />

Figure 35. Project documentation

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!