CLion 2016.3 Help

Creating and Viewing Doxygen Documentation

In this section:

Basics

Doxygen-style comments can be placed across the source code and used for generating full-fledged documentation in various formats. In case you have a project documented this way, you can easily run Doxygen tool from the built-in terminal in CLion to get the documentation . Besides, CLion allows you getting more value out of Doxygen comments inside the IDE itself.

CLion includes the information from Doxygen-styled comments into the Quick Documentation pop-up:

/help/img/idea/cl_doxygen_view.png

Viewing Documentation

Doxygen-styled information is included in Quick Documentation pop-up in addition to the type information. To invoke the documentation pop-up, do the following:

  1. Place the caret at the desired symbol or at the @param command of the Doxygen comment.
  2. Press Ctrl+Q.
Alternatively, when the check box Show quick doc on mouse move in the editor settings is selected, just move your mouse pointer over the desired symbol.

If function parameters are documented separately from the function description, CLion will merge all the comments and show you the full function’s signature documentation.

/help/img/idea/cl_doxygenMerge.png

Creating Comment from Scratch

To create a Doxygen comment for a function from scratch, do the following:

  1. Type each of the following symbols: ///, //!, /** or /*! at your choice, followed by Enter.
  2. Fill a stub that is created with the required documentation text.

Reliable Rename

While changing a function name or its parameters names, you definitely need Doxygen comments updated accordingly. CLion does that for you in case you are using Rename refactoring:

Before:

/help/img/idea/cl_DoxygenRenameBefore.png

After:

/help/img/idea/cl_DoxygenRenameAfter.png

Typing Assistance

Basic typing assistance for Doxygen commands is provisioned by CLion auto-complete feature.

/help/img/idea/cl_DoxygenAssistance.png
Note, that not all commands are available in the completion. The recent list of the commands that are not supported for the moment can be found here.

See Also

Last modified: 22 November 2016