IntelliJ IDEA 2018.2 Help

Viewing External Documentation

External documentation makes it possible to get additional information for the symbols at caret. In contrast to the quick documentation, this feature shows the documentation in an external browser, which helps study the symbol in more detail, navigate to related symbols, and retain the information for further reference.

Configure the external documentation path

To view external documentation in a browser, you need to configure the documentation URL first.

  1. In the Project Structure dialog (Ctrl+Shift+Alt+S), select SDKs.
  2. Select the necessary JDK version if you have several JDKs configured, and click Documentation Paths.
  3. Click icons toolbarDecorator addLink svg (Specify URL), and enter the external documentation URL. For example, for Java 8, type https://docs.oracle.com/javase/8/docs/api/.
  4. Apply the changes and close the dialog.

Access external documentation offline

If you work offline, you can view external documentation locally.

  1. Download the documentation package of the necessary Java version from the official Oracle website.

    The documentation package is distributed in a ZIP archive that you need to unpack once it is downloaded.

  2. In the Project Structure dialog (Ctrl+Shift+Alt+S), select SDKs.
  3. Select the necessary JDK version if you have several JDKs configured.
  4. Click icons general add svg (Add) and specify the directory with the downloaded documentation package (for example, C:\Users\john.doe\Desktop\docs\api).
  5. Apply the changes and close the dialog.

View external documentation

  • To view documentation for a symbol at caret in an external browser, go to View | External documentation, or press Shift+F1.
Last modified: 4 September 2018

See Also

Reference: