Searching Javadoc Documentation

See Also

In order to view Javadoc documentation for any elements of code you are writing, you must add the Javadoc library containing the documentation to the project. See Adding a Javadoc Library to a Project for more information.

Once you have added a Javadoc library to the project, you can view the documentation for any of the library's classes right from the Source Editor, browse the documentation in your external browser, and search the library using the Javadoc Index Search.

To search a project's Javadoc libraries:

  1. Choose View and choose Javadoc Index Search (Shift-F1).

    The Javadoc Index Search opens in a Source Editor tab.

  2. Enter the search criteria and click Find. You can search for a specific class, interface, constructor, method, or field. You cannot search for a package in the Javadoc Index Search.
  3. Click any of the results to display the documentation in the bottom pane of the Javadoc Index Search tab. To view the documentation in the IDE's external browser, double-click the result.
Tip If an element of code is selected in the Filesystems window or Source Editor when you open the Javadoc Index Search, the IDE automatically searches for the code element.

To open a code element's Javadoc page in the external web browser without viewing the search page, place your insertion point on the code element in the Source Editor and press Alt-F1.

See Also
Turning Off Exact Case Matching for Javadoc Searches
Generating Javadoc Documentation
Javadoc Index Search

Legal Notices