Access Javadoc in Eclipse-based IDEs

Related Topics ... Overview: Configuring a Development Environment WebSphere Portlet Factory API Documentation

We can access the Javadoc for objects in your Java code with the F2 key (to display a brief description as a "tool tip") or SHIFT+F2 to display the Javadoc for that object. If there is no "tool tip" content or if your IDE displays a dialog saying that the documentation location has not been set, we can set the Javadoc Location property for the JAR mentioned in the dialog.

To set the Javadoc Location for a JAR in your project:

1. In the Java perspective for the project, right-click on the JAR file mentioned in the dialog. For example, WEB-INF/lib/factory.jar.

2. In the Properties dialog, select the Javadoc Location property.

3. Use the Browse button to set the Javadoc Location input to the Factory doc plugin directory. For example:

file:/C:/Program Files/IBM_5.x.x/IBM Designer/plugins/com.bowstreet.designer.doc_5.x.x/api/.

4. Verify that there is Javadoc at the specified location by clicking the Validate button.

5. Click OK in the Properties dialog.