Code reference information
The Parameter Info popup shows the names of parameters in method and function calls. RubyMine automatically shows a popup with all available method signatures within 1 second (1000 milliseconds) after you type an opening bracket in the editor, or select a method from the suggestion list.
You can explicitly invoke the popup if it has closed or if your IDE is configured not to show the popup automatically. To do so, press Control+P (or click ).
Show full method or function signatures
By default, the parameter info popup shows simple signatures. You can configure the IDE to show full signatures that include method names and returned types.
In the Settings dialog (Control+Alt+S), go to , and select the Show full method signatures checkbox.
Configure the parameter info popup
In the Settings dialog (Control+Alt+S), go to .
In the Show the parameter info popup in ... milliseconds field, specify the time in milliseconds after which the popup should appear.
If you don't want the popup to appear automatically, clear the Show the parameter info popup in ... milliseconds checkbox.
Inlay hints are special markers that appear in the editor and provide you with additional information about your code, like the names of the parameters that a called method expects. There are different kinds of inlay hints for annotations, method parameters, usages, problems, and so on.
Configure inlay hints
Go to Hints Settings.. Alternatively, right-click a hint and select
Use the checkboxes to enable or disable particular inlay hints.
If you don't want to see parameter hints for specific cases, you can configure the list of exceptions. By default, the exception list contains a number of pre-defined methods. You can remove a method from the list to see the hints for it, or add new methods to hide their hints in the editor.
You can get quick information for any symbol right from the editor by means of the Quick Documentation feature. It shows you code documentation in a popup as you hover over code elements. Note that the symbol must be supplied with documentation comments created in accordance with the YARD or RDoc markup or with the SDK documentation.
Quick Documentation in a popup
View Quick Documentation in a popup
Hover over the necessary symbol in the editor.
Place the caret at the symbol and press Control+Q ().
Press Control+Q again to open this documentation in the Documentation tool window.
Click in the popup to change the font size, display the quick documentation toolbar, or go to the source code.
Disable Quick Documentation on hover
By default, the quick documentation popup appears as you hover over code elements. You can configure the IDE to display the popup only after you explicitly invoke the Quick Documentation feature.
Click in the popup and disable the Show on Mouse Move option.
In the Settings dialog (Control+Alt+S), go to and clear the Show quick documentation on hover checkbox.
In this case, to view documentation for a symbol at caret, press Control+Q or select display it in the tool window right away.from the main menu. The documentation will be shown in a popup, but you can configure the IDE to
Quick Documentation in the tool window
View documentation in the tool window
With the default settings, pressing Control+Q () opens quick documentation in a popup. You can change the settings to view documentation in the tool window.
In the quick documentation popup, click and disable the Show Documentation Popup First option.
In the Documentation tool window, click the icon on the tool window toolbar and disable the Show Documentation Popup First option.
Keep documentation in the tool window
You can open a piece of documentation for a specific code element in the tool window and keep viewing documentation for other elements in your current file.
Place the caret at the required code element and press Control+Q. If the popup appears, press Control+Q again to switch to the tool window.
The asterisk symbol (
*) on the documentation tab means that the tab is not pinned, so its content will be replaced by documentation for another code element that you select in the editor.
Right-click the tab with the documentation in the documentation tool window and enable the Keep This Documentation option.
After that, the current documentation tab will be pinned. You can return to the editor and view documentation for other code elements that will open either in the popup or in a new tab in the tool window.
When you are viewing code documentation in the tool window, it is displayed on the unpinned tab (the tab marked with the asterisk symbol (
*). There are several ways in which you can work with it:
You can view documentation by hovering over code elements.
Click the icon on the tool window toolbar and enable the Show on Mouse Move and Auto-Update from Source options.
You can view documentation as you place the caret at symbols in the editor either by clicking them or by moving the caret.
Click the icon on the toolbar, disable the Show on Mouse Move and enable the Auto-Update from Source options.
You can view documentation by placing the caret at a symbol and pressing Control+Q or selectingfrom the main menu.
Click the icon on the tool window toolbar, disable the Show on Mouse Move and Auto-Update from Source options.
In RubyMine, you can identify the type of an expression in the following way:
Place the caret at the necessary code element and press Control+Shift+P (or selectfrom the main menu).
External documentation opens the necessary information in a web browser, so that you can navigate to related symbols, and keep the information for further reference at the same time.
View external documentation
To view documentation for a symbol at the current caret position in a web browser, press Shift+F1 (or click).
- Copy tooltip text to the clipboard
To copy tooltip text to the clipboard, hold Alt (on Linux, hold Ctrl+Alt) and click the tooltip.
- View context information
If the current method or class declaration is not visible, you can view it in the tooltip by pressing Alt+Q.