For a project symbol or for a symbol from the project dependencies, RubyMine generates the documentation from the corresponding JSDoc comment.
If no comment is found in the d.ts files, RubyMine shows a summary from the corresponding MDN article.
By default, documentation is shown in the Documentation popup but you can configure it to appear in the Documentation tool window.
Quick Documentation in a popup
Hover the mouse over the necessary symbol in the editor.
Place the caret at the symbol and press Ctrl+Q or selectfrom the main menu.
Press Ctrl+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.
Click in the popup to change the font size, display the quick documentation toolbar, or go to the source code. See Quick Documentation in a popup for details.
Quick Documentation in the tool window
With the default settings, pressing Ctrl+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.
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.
In the tool window, code documentation is displayed on the unpinned tab (the tab marked with the asterisk symbol (
*). You can view this documentation by hovering over a symbol or placing the caret at it. See Quick Documentation tool window: modes.
MDN documentation for symbols
In the Documentation popup Ctrl+Q, click the link at the bottom:
Press Shift+F1 or selectfrom the main menu.
RubyMine opens the MDN article in the default RubyMine browser.
Position the caret at the symbol and press Shift+F1 or choosefrom the main menu.
Documentation for npm packages
In a package.json file or in a
importstatement, position the caret at the name of the package and press Ctrl+Q
To open the documentation on the npm official website in the browser, press Shift+F1.