Javadoc tooling
Javadoc is a very useful tool in the Java Development Kit used to document Java code. It generates Web-based (HTML files) documentation of the packages, interfaces, classes, methods, and fields.
RAD v7.5 has a Javadoc view, which is implemented using a SWT browser widget to display HTML. In the Java perspective, the Javadoc view is context sensitive. It only displays the Javadoc associated with the Java element where the cursor is currently located within the Java editor.
To demonstrate the use of Javadoc, we use the RAD75JavaImport project that we imported.
| Open the Javadoc view in the Java perspective if it is not already open. |
|
| Open the BankClient class in the Java editor. |
|
| You will notice that when the cursor selects a type, its Javadoc is shown in the Javadoc view. Select the BigDecimal type, and the Javadoc view changes to the documentation associated with BigDecimal (Figure | -37). |
Figure 8-37 Javadoc view: Context sensitive (BigDecimal)
|
ibm.com/redbooks |