# Viewing Inline Documentation

> For the complete documentation index, see [llms.txt](https://www.jetbrains.com/help/ruby/2026.3/llms.txt).

## Quick documentation look-up

> **Tip:**
> RubyMine can show documentation automatically only when you invoke completion explicitly with `Ctrl+Space` (Windows), `⌃ Space` (macOS), `⌃ Space` (IntelliJ IDEA Classic (macOS)), `⌃ Space` (macOS System Shortcuts), `Ctrl+Space` (XWin), `Ctrl+Space` (GNOME), `Ctrl+Space` (KDE), `Alt+/` (Emacs), `Ctrl+Space` (Sublime Text), `⌃ Space` (Sublime Text (macOS)), `Ctrl+Space` (Visual Studio), `⌃ Space` (Visual Studio (macOS)), `Ctrl+Space` (TextMate), `Ctrl+Space` (NetBeans), `Ctrl+Space` (Eclipse), `⌃ Space` (Eclipse (macOS)).

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](https://github.com/jsdoc3/jsdoc/) format.

To view documentation for a symbol at caret

Press `Ctrl+Q` (Windows), `F1` (macOS), `⌃ J` (IntelliJ IDEA Classic (macOS)), `⌘ I` (macOS System Shortcuts), `Ctrl+Q` (XWin), `Ctrl+Q` (GNOME), `Ctrl+Q` (KDE), `Ctrl+Q` (Emacs), `Ctrl+Q` (Sublime Text), `Ctrl+Q` (Sublime Text (macOS)), `Ctrl+K, I` (Visual Studio), `⌘ K, I` (Visual Studio (macOS)), `Ctrl+Middle-Click` (TextMate), `Ctrl+Q` (NetBeans), `Alt+Middle-Click` (Eclipse), `⌥ Middle-Click` (Eclipse (macOS)) or select `View | Quick Documentation Lookup` from the main menu.

To show documentation automatically

1.    In the Settings dialog (`Ctrl+Alt+S` (Windows), `⌘ Comma` (macOS), `⌘ Comma` (IntelliJ IDEA Classic (macOS)), `⌘ Comma` (macOS System Shortcuts), `Ctrl+Alt+S` (XWin), `Ctrl+Alt+S` (GNOME), `Ctrl+Alt+S` (KDE), `Ctrl+Alt+S` (Emacs), `Ctrl+Alt+S` (Sublime Text), `⌘ Comma` (Sublime Text (macOS)), `Ctrl+Alt+S` (Visual Studio), `⌘ Comma` (Visual Studio (macOS)), `Meta+Comma` (TextMate), `Ctrl+Alt+S` (NetBeans), `Ctrl+Alt+S` (Eclipse), `⌘ Comma` (Eclipse (macOS))), go to `Editor | General | Code Completion`.  The  [Code completion](auto-completing-code.html#code_completion_options) 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.png](https://resources.jetbrains.com/help/img/idea/2026.3/show-slider.png) in the upper-right corner of the quick documentation window, and move the slider.

* Alternatively In the Settings dialog (`Ctrl+Alt+S` (Windows), `⌘ Comma` (macOS), `⌘ Comma` (IntelliJ IDEA Classic (macOS)), `⌘ Comma` (macOS System Shortcuts), `Ctrl+Alt+S` (XWin), `Ctrl+Alt+S` (GNOME), `Ctrl+Alt+S` (KDE), `Ctrl+Alt+S` (Emacs), `Ctrl+Alt+S` (Sublime Text), `⌘ Comma` (Sublime Text (macOS)), `Ctrl+Alt+S` (Visual Studio), `⌘ Comma` (Visual Studio (macOS)), `Meta+Comma` (TextMate), `Ctrl+Alt+S` (NetBeans), `Ctrl+Alt+S` (Eclipse), `⌘ Comma` (Eclipse (macOS))), 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](null), with the corresponding sidebar icon, and more controls.

To switch between the Documentation popup and the [Documentation tool window](null), use `Ctrl+Q` (Windows), `F1` (macOS), `⌃ J` (IntelliJ IDEA Classic (macOS)), `⌘ I` (macOS System Shortcuts), `Ctrl+Q` (XWin), `Ctrl+Q` (GNOME), `Ctrl+Q` (KDE), `Ctrl+Q` (Emacs), `Ctrl+Q` (Sublime Text), `Ctrl+Q` (Sublime Text (macOS)), `Ctrl+K, I` (Visual Studio), `⌘ K, I` (Visual Studio (macOS)), `Ctrl+Middle-Click` (TextMate), `Ctrl+Q` (NetBeans), `Alt+Middle-Click` (Eclipse), `⌥ Middle-Click` (Eclipse (macOS)).

| Item | Shortcut | Description |
| --- | --- | --- |
| ![](https://resources.jetbrains.com/help/img/idea/2026.3/app.actions.back.svg) ![](https://resources.jetbrains.com/help/img/idea/2026.3/app.actions.forward.svg) | `Left` (Windows), `←` (macOS), `←` (IntelliJ IDEA Classic (macOS)), `←` (macOS System Shortcuts), `Left` (XWin), `Left` (GNOME), `Left` (KDE), `Left` (Emacs), `Left` (Sublime Text), `←` (Sublime Text (macOS)), `Left` (Visual Studio), `←` (Visual Studio (macOS)), `Left` (TextMate), `Left` (NetBeans), `Left` (Eclipse), `←` (Eclipse (macOS)) or `Right` (Windows), `→` (macOS), `→` (IntelliJ IDEA Classic (macOS)), `→` (macOS System Shortcuts), `Right` (XWin), `Right` (GNOME), `Right` (KDE), `Right` (Emacs), `Right` (Sublime Text), `→` (Sublime Text (macOS)), `Right` (Visual Studio), `→` (Visual Studio (macOS)), `Right` (TextMate), `Right` (NetBeans), `Right` (Eclipse), `→` (Eclipse (macOS)) | Switch to the previous or next documentation page (e.g. after using hyperlinks).    > **Note:** > On a macOS computer, you > > can also use the three-finger right-to-left and left-to-right swipe gestures.     |
|  ![](https://resources.jetbrains.com/help/img/idea/2026.3/app.expui.general.edit.svg)  |  `F4` (Windows), `⌘ ↓` (macOS), `F4` (IntelliJ IDEA Classic (macOS)), `F4` (macOS System Shortcuts), `F4` (XWin), `F4` (GNOME), `F4` (KDE), `F4` (Emacs), `F4` (Sublime Text), `F4` (Sublime Text (macOS)), `F4` (Visual Studio), `⌘ ↓` (Visual Studio (macOS)), `F4` (TextMate), `F4` (NetBeans), `F12` (Eclipse), `F3` (Eclipse (macOS))  | Switch to the item (e.g. source) that corresponds to the documentation page currently shown. |
|  ![Settings](https://resources.jetbrains.com/help/img/idea/2026.3/app.expui.general.settings.svg)  |  | Click this icon to perform the following actions:       * 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 position.    |

## See also

### Reference

[Code reference information](viewing-reference-information.html)

