RubyMine 7.0.0 Web Help

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.

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
Click thumbnail to view larger image.

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
Click thumbnail to view larger image.

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 or Alt+Button2 ClickCtrl+Q or Alt+Button2 ClickCtrl+Q or Alt+Button2 ClickCtrl+Q or Alt+Button2 ClickCtrl+Q or Alt+Button2 ClickCtrl+QCtrl+Q or Alt+Button2 ClickAlt+Button2 Click, Ctrl+Shift+Space or F2Ctrl+Button2 Click or Ctrl+HF1, Control J or Control Button2 ClickControl J or Control Button2 ClickAlt Button2 Click or F2Control J or Control Button2 Click.
  • 6.3+
    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.

Tip

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

ruby_quickDocumentationLookupFromDeclaration.png

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.

5.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+LeftShift+Alt+LeftShift+Alt+LeftShift+Alt+LeftShift+Alt+LeftShift+Alt+LeftCtrl+Alt+Page UpCtrl+Shift+Alt+RightCtrl+Shift+LeftControl Shift LeftControl Shift LeftControl Shift LeftShift Alt Command Open Bracket or Shift+Alt+RightShift+Alt+RightShift+Alt+RightShift+Alt+RightShift+Alt+RightShift+Alt+RightCtrl+Alt+Page DownCtrl+Shift+Alt+LeftCtrl+Shift+RightControl Shift RightControl Shift RightControl Shift RightShift Alt Command Close Bracket Navigate to the previous or next screen after using hyperlinks in the definition.

Note

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

arrowUp.png Shift+F1Shift+F1Shift+F1Shift+F1Shift+F1Shift+F1 or Ctrl+F1Shift+F1Shift+F2Shift+F1Shift F1Shift F1Shift F2Shift F1 View external documentation in the default browser.
edit F4F4F4F4F4F4F4F12 or Ctrl+Shift+EF4Command Down or F4F4F3F4 Click this icon to view and edit the documentation sources.
autoscrollFromSource Select this icon to update documentation from the sources automatically.
close Ctrl+Q or Alt+Button2 ClickCtrl+Q or Alt+Button2 ClickCtrl+Q or Alt+Button2 ClickCtrl+Q or Alt+Button2 ClickCtrl+Q or Alt+Button2 ClickCtrl+QCtrl+Q or Alt+Button2 ClickAlt+Button2 Click, Ctrl+Shift+Space or F2Ctrl+Button2 Click or Ctrl+HF1, Control J or Control Button2 ClickControl J or Control Button2 ClickAlt Button2 Click or F2Control J or Control Button2 Click 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 or Alt+Button2 ClickCtrl+Q or Alt+Button2 ClickCtrl+Q or Alt+Button2 ClickCtrl+Q or Alt+Button2 ClickCtrl+Q or Alt+Button2 ClickCtrl+QCtrl+Q or Alt+Button2 ClickAlt+Button2 Click, Ctrl+Shift+Space or F2Ctrl+Button2 Click or Ctrl+HF1, Control J or Control Button2 ClickControl J or Control Button2 ClickAlt Button2 Click or F2Control J or Control Button2 Click toggles the focus of the Quick Documentation pop-up window and Documentation Tool Window.

See Also

Procedures:

Reference:

Web Resources: