IntelliJ IDEA 14.1.0 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.

So doing, such documentation is properly rendered in the Documentation Tool Window, and in the gem manager. In case of multiple declarations, a list of possible inferred types is displayed.

ruby_quickDocumentationLookup.png

The URLs and e-mail addresses specified in the documentation comments for methods are also properly rendered. Clicking a hyperlink opens the corresponding URL in an external browser; clicking e-mail address opens the default mail client.

ruby_quickDefinitionLookupURL.png

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.
  • 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.

When you explicitly invoke code completion, then quick documentation for an entry selected in the suggestion list can be displayed automatically. The behavior of quick documentation lookup is configured in the Code Completion page of the Settings dialog.

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.

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

IconKeyboard shortcutAction
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+QClick 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

See Also

Last modified: 14 July 2015