Viewing Documentation From the Source Editor

From the Source Editor, you can create a URL to the Javadoc documentation for an entity and display it in the web browser. The appropriate Javadoc filesystem must be mounted in the Explorer and the parser database must be updated for your source file.

To display Javadoc documentation from the Source Editor:

  1. Place the pointer in the entity (class, interface, method, constructor, or field) whose documentation you want to display.
  2. Press Alt-F1, or right-click and choose Show Javadoc from the contextual menu.

    If there are multiple matching methods that vary only in their signature, the Javadoc documentation that is displayed depends on the location of the insertion point.

Tip If the code completion box is displayed at the time you press Alt-F1, the resulting action is based on the selection in the completion box. If a package is selected in the completion box, Alt-F1 opens the Javadoc documentation for the whole package.

See also
Searching Through Javadoc-Generated Documentation
Mounting a Javadoc Filesystem
Updating the Parser Database

Legal Notices