Page 810 - Introduction to Programming with Java: A Problem Solving Approach

776 Appendix 6 Javadoc
This creates interface documentation for both classes and outputs that combined documentation to the docs subdirectory. Figure A6.6a shows what you’ll see if you open a web browser, navigate to the docs direc- tory, click on index.html, and select Salaried_jd in the left panel under “All Classes.”
link to superclass
everything in general comment
Apago PDF Enhancer
Figure A6.6a
javadoc output for javadoc-commented Salaried class—part A
In the right panel, near the top, you can see the documentation of Salaried_jd’s inheritance from Employee. In the Salaried_jd documentation, Employee is colored and underlined in several places. These are links, and if you click on any of them, the display switches immediately to the Employee class’s documentation. In Figure A6.5, our general comment had two sentences, and both of these sentences appear in the general comment in Figure A6.6a. Notice that the constructor and method summary blocks do not contain any comments. The @param and @return tags do not produce any summary-block output. If we had included text in the javadoc comment block above the constructor or method heading in Figure A6.5, only the first sentence of that text (the “summary” sentence) would appear in the corresponding summary block in Figure A6.6a.