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 on the main menu.
To show documentation automatically
In the Settings/Preferences dialog (Ctrl+Alt+S), go to . The Code completion page opens.
Select the Show the documentation popup checkbox and specify the elapsed time.
To change the font size of quick documentation
Click
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 popup 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 popup turns into the Documentation tool window, with the corresponding sidebar icon, and more controls.
To switch between the Documentation popup and the Documentation tool window, use Ctrl+Q.
Item | Shortcut | Description |
|---|---|---|
| Left or Right | Switch to the previous or next documentation page (e.g. after using hyperlinks). |
| F4 | Switch to the item (e.g. source) that corresponds to the documentation page currently shown. |
| Click this icon to perform the following actions:
|
