Documentation tool window

Last modified: 01 September 2023

View | Tool Windows | Documentation

By default, CLion shows Quick Documentation in a popup; to view it in the tool window, click App actions more in the popup and choose Open in Documentation Tool Window or press twice.

CLion: Documentation tool window

note

The View | Tool Windows | Documentation menu option appears only if you have configured the IDE to display code documentation in a tool window and some documentation is open in the window.

Icon

Shortcut

Description

the Back button  the Forward button

or

Switch to the previous or go to the next documentation page (for example, after clicking hyperlinks).

On macOS, you can also use the three-finger right-to-left and left-to-right swipe gestures.

the Edit Source button

Navigate to the source code of the symbol whose documentation is currently open.

Settings

  • Open as Popup : show code documentation in a popup instead of the tool window.

  • Auto-update from Source: when this option is enabled, the content of the tool window changes as you move the mouse pointer in the editor.

    If the Show on Mouse Move option is disabled, place the caret at the symbol and press to see its documentation in the tool window.

  • Adjust Font Size: display a slider for changing the font size.

  • View Mode: by default, the tool window is attached to the edge of the main window and is always visible. You can change the view mode, for example, to make it visible only when active or to detach it from the tool window bar.

  • Move to: select where to attach the tool window.

  • Resize: adjust the size of the tool window.

  • Remove from Sidebar: close the tool window. To reopen it, select View | Tool Windows | Documentation from the main menu.

See also

Procedures