RubyMine 2017.2 Help

Keymap:

Viewing Inline Documentation

Basics

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.

RubyMine recognizes inline documentation created in accordance with RDoc and YARD.

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 an e-mail address opens the default mail client.

Viewing quick documentation

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/Preferences dialog.

In case of multiple declarations, you can invoke Quick Documentation Lookup immediately from the Choose declaration pop-up list:

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, changing 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.

Icon

Shortcut

Description

Left or Right

Switch to the previous or next documentation page (e.g. after using hyperlinks).

On a macOS computer, you can also use the three-finger right-to-left and left-to-right swipe gestures.

Shift+F1

View external documentation in the default browser.

F4

Switch to the item (e.g. source) that corresponds to the documentation page currently shown.

Turn the Auto-update from source option on or off. When the option is on, the information in the tool window is synchronized with your navigation in the editor and other places in the UI.

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.