CLion 2018.3 Help

Quick Documentation Lookup

Quick Documentation pop-up (Ctrl+Q) is a universal tool to help you get more information on a code element at the caret. Depending on the element you call Quick Documentation for, the pop-up can include:

  • Function signature details.

  • Code documentation (either regular or Doxygen comments).

  • Inferred types, which is especially valuable for modern C++ that might lack explicit types. For example:

    c++ inferred type in quick documentatio pop-up

  • Macro replacements to help you better understand and debug nested macros (like Boost.Test or Catch macros). In the pop-up, you will see the final macro replacement properly formatted, with highlighted strings and keywords:

    Formatted macro expansion in quick documentation pop-up

To view Quick Documentation for a symbol at the caret

  • On the main menu, choose View | Quick Documentation Lookup.

  • Press Ctrl+Q.

  • If the Show quick doc on mouse move checkbox in the editor settings is selected, just hover the mouse over the desired symbol.

To change the font size of Quick Documentation

  • Click Quick Documentation Settings and move the slider.

  • Rotate the mouse wheel while keeping the Ctrl/⌘ key pressed. For this feature to work, you need to enable Change font size (Zoom) with Ctrl/⌘+Mouse Wheel in the General editor settings.

Last modified: 14 February 2019

See Also