Creating and Viewing Doxygen Documentation
In this section:
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:
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:
- Place the caret at the desired symbol or at the
@paramcommand of the Doxygen comment.
- Press Ctrl+Q.
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.
Creating Comment from Scratch
To create a Doxygen comment for a function from scratch, do the following:
- Type each of the following symbols:
/*!at your choice, followed by Enter.
- Fill a stub that is created with the required documentation text.
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:
Basic typing assistance for Doxygen commands is provisioned by CLion auto-complete feature. 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.