RubyMine 2018.2 Help

Viewing Inline Documentation

Quick documentation look-up

Quick documentation look-up helps you get quick information for any symbol that is supplied with Documentation comments in the applicable format. RubyMine recognizes inline documentation created in accordance with the JavaScript Documentation Tool format.

To view documentation for a symbol at caret
Press Ctrl+Q or choose View | Quick Documentation Lookup on the main menu.

To show documentation automatically

  1. In the Settings/Preferences dialog (Ctrl+Alt+S), click General under Editor, then click Code Completion. The Code Completion page opens.
  2. Select the Show the documentation popup checkbox and specify the elapsed time.

To change the font size of quick documentation

  • Click show slider in the upper-right corner of the quick documentation window, and move the slider.
  • Alternatively
    In the Settings/Preferences dialog (Ctrl+Alt+S), click General under Editor and select the Change font size (Zoom) with Ctrl+Mouse Wheel checkbox.

Documentation window

The Documentation pop-up 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 Documentation pop-up window turns into the Documentation tool window, with the corresponding sidebar icon, and more controls.

To switch between the Documentation pop-up window and the Documentation tool window, use Ctrl+Q.

ItemShortcutDescription
icons actions back svg icons actions forward svgLeft or RightSwitch to the previous or next documentation page (e.g. after using hyperlinks).
icons actions edit svg F4 Switch to the item (e.g. source) that corresponds to the documentation page currently shown.
Settings Click this icon to perform the following settings:
  • Show the font size slider. Move the slider to increase or decrease the font size in the quick documentation window as required.
  • Enable or disable auto-update of documentation from its source.
  • Control the window's position.
Last modified: 31 August 2018

See Also