CLion
 
2024.3
Get CLion

Quick documentation

Last modified: 31 October 2024

Quick Documentation popup helps you get more information on a code element at caret. CLion shows quick documentation in a popup on mouseover automatically. Depending on the element you invoke it for, the popup can include:

  • Function signature details and code documentation (either regular or Doxygen comments):

    Function signature details with Doxygen comments
  • Inferred types:

    C++ inferred type in Quick Documentation popup
  • Copy/move details for structs and classes. In the example below, you can also refer to the TODO comments included in the popup:

    Copyability/movability of a struct/class
  • For a standard function, structure, or another item, the popup also includes a link to its cppreference:

    The link to external documentation
  • Macro replacements to help you better understand and debug nested macros (like Boost.Test or Catch macros).

    In the popup, you will see the final macro replacement properly formatted, with highlighted strings and keywords:

    Formatted macro expansion in Quick Documentation popup
  • Value and size of a constant expression evaluated at compile time:

    Values of constant expressions

    Compile-time evaluation is especially helpful for working with constexpr and consteval calculations and in template metaprogramming:

    Evaluated values
  • Enumeration values as integer:

    Enum values
  • CMake code elements

    In CMake scripts, CLion shows documentation for variables, commands, properties, modules, and policies. For example, you can view quick documentation for completion suggestions in find_package:

    Quick doc in CMake completion

    tip

    Find out more in Code insight for CMake.