13.07.2015 Views

Java™ Application Development on Linux - Dator

Java™ Application Development on Linux - Dator

Java™ Application Development on Linux - Dator

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.

5.5 Complete, Up-to-Date Program Documentati<strong>on</strong> Made Easy127recommend adding $Id$ after the versi<strong>on</strong> tag, which CVS will automaticallyreplace by its ID string c<strong>on</strong>taining the filename, CVS revisi<strong>on</strong> number,date/time and the author of last check-in. (For more about CVS, seeChapter 8.)-authorCauses any @author tag data to be included in the documentati<strong>on</strong>.-splitindexCauses the alphabetical index to be broken into multiple pages, <strong>on</strong>e perletter. Can be useful when you have a very large number of classes and/orpackages documented in a single Javadoc document set.-windowtitle titleSets the title for the document set. The text that follows this switch willgo into the HTML element <strong>on</strong> documentati<strong>on</strong> pages.-nodeprecatedThis causes all deprecated methods and classes to go undocumented.Normally they are documented, but marked as deprecated.-nodeprecatedlistDrops deprecated classes and methods from indexes, lists, and crossreferences,but leaves the actual documentati<strong>on</strong> in place.There are actually many more switches. Some of the most important thatwe haven’t covered are the -link, -linkoffline, and related tags. If you endup producing many API packages and document them separately, you can usethese switches to link your separate Javadoc documentati<strong>on</strong> together seamlessly,so that when you use classes from separately documented packages, the referencesin the documentati<strong>on</strong> for your code will be live links to that separatedocumentati<strong>on</strong>. For details <strong>on</strong> these and other switches, see the Sundocumentati<strong>on</strong> <strong>on</strong> javadoc. 44. http://java.sun.com/j2se/1.4.2/docs/tooldocs/solaris/javadoc.html

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

Saved successfully!

Ooh no, something went wrong!