IntelliJ IDEA 14.0.0 Web Help

Viewing Inline Documentation

Quick Documentation Lookup helps you get quick information for any symbol or just method signature information, provided that this symbol has been supplied with Documentation comments in the applicable format.

IntelliJ IDEA recognizes inline documentation created in accordance with Javadoc markup.

In this case, such documentation is properly rendered in the Quick Documentation Lookup window:

quickDocumentationLookup.png

For markup languages, IntelliJ IDEA retrieves reference from the language specification according to the Document Type setting.

In this section:

To view documentation for a symbol at caret, do one of the following

  • On the main menu, choose View | Quick Documentation Lookup .
  • Press Ctrl+Q.
  • 13.0+
    Provided that the check box Show quick doc on mouse move in the editor settings is selected, just move your mouse pointer over the desired symbol.

To change the font size of quick documentation, do one of the following

  • Click show-slider in the upper-right corner of the quick documentation window, and move the slider.
  • Rotate the mouse wheel while keeping the Ctrl key pressed.

Toolbar of the Quick Documentation Lookup

The Quick Documentation Lookup window helps navigate to the related symbols via hyperlinks, and provides a toolbar for moving back and forth through the already navigated pages, change font size, and viewing documentation in an external browser.

12.0+

When pinned, the Quick Documentation Lookup turns into Documentation Tool Window, with the corresponding sidebar icon, and more controls.

Icon Keyboard shortcut Action
arrowBack arrowForward Shift+Alt+Left or Shift+Alt+Right Navigate to the previous or next screen after using hyperlinks in the definition.
arrowUp.png Shift+F1 View external documentation in the default browser.
edit F4 Click this icon to view and edit the documentation sources.
autoscrollFromSource Select this icon to update documentation from the sources automatically.
close Ctrl+Q Click this icon to restore the documentation source pop-up window to the previous size.
show-slider Click this icon to show font size slider. Move the slider to increase or decrease the font size in the quick documentation window as required.

Tips and tricks

  • Sequential pressing Ctrl+Q toggles the focus of the Quick Documentation pop-up window and Documentation Tool Window.
  • The following is available only in the Ultimate edition of IntelliJ IDEA

    For information on retrieving inline documentation in the JavaScript or PHP context, refer to sections Viewing JSDoc Comments and Viewing PHPDoc Comments respectively.

See Also

Last modified: 4 December 2014
comments powered by Disqus