Viewing Javadoc information

The JDT provides easy access to Javadoc information for the code edited in the Java editor.
  1. Open the Java editor on a Java file.
  2. Ensure that the Show Text Hover button  in the workbench toolbar is toggled on.
  3. Place the mouse pointer over the element whose Javadoc information you want to view (a method name, for example).
  4. If Javadoc information is available, a pop-up window opens, displaying the Javadoc information. HTML Javadoc can be viewed as any other resource in the workbench, through an embedded or external editor or viewer. Import the Javadoc into the workbench and double-click it in the Package Explorer.

You can also view Javadoc information by:

  1. Opening the Java editor on a Java file.
  2. Placing the mouse pointer over the element whose Javadoc information you want to view (a method name, for example).
  3. Pressing F2 or selecting Edit > Show Tooltip Description from the menu bar.

To view Javadoc in an external browser:

  1. Opening the Java editor on a Java file.
  2. Placing the caret over the element whose Javadoc information you want to view (a method name, for example).
  3. Pressing Shift+F2 or selecting Navigate > Open External Javadoc from the menu bar.


Related concepts

Java editor

Related tasks

Using the Java editor
Using content/code assist
Viewing documentation and information
Viewing marker help

Related reference

Package Explorer
Javadoc Location
 

Copyright IBM Corporation 2000, 2002. All Rights Reserved.