RubyMine 5.4.3 Web Help

Quick Documentation Lookup helps you get quick information for any symbol, provided that this symbol has been supplied with Documentation comments in the applicable format. RubyMine recognizes inline documentation created in accordance with the JavaScript Documentation Tool format.

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+Q or Shift+F1Ctrl+Q or Alt+Button2 ClickAlt+Button2 Click, Ctrl+Shift+Space or F2Ctrl+Button2 Click or Ctrl+HControl J or Control Button2 ClickControl J or Control Button2 ClickAlt Button2 Click or F2Control J or Control Button2 Click.

Note

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

Quick documentation lookup window

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

Note

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

arrowUp.pngShift+F1Shift+F1Shift+F1Shift+F1Shift+F1Shift+F1 or Ctrl+F1Shift+F1Shift+F2Shift+F1Shift F1Shift F1Shift F2Shift F1View external documentation in the default browser.
show-sliderClick this button to show font size slider. Move the slider to increase or decrease the font size in the quick documentation window as required.

See Also

Reference:

Web Resources: