Is Intellij IDEA currently support Doxygen? Everything seems to indicate that Doxygen is only supported CLion in 2016.2 version and higher. To keep the documentation correct, use Rename refactoring Shift+F6 to update function name or its parameters. CLion will get the Doxygen comments updated as well as other references.
Remarks
This section provides an overview of what doxygen is, and why a developer might want to use it.
It should also mention any large subjects within doxygen, and link out to the related topics. Since the Documentation for doxygen is new, you may need to create initial versions of those related topics.
Clion Doxygen List
Commenting your code
Camtasia webcam settings. There are several ways to mark a comment block as a detailed description, so that this comment block is parsed by Doxygen and added as a description of the following code item to the documentation. The first and most common one are C style comments with an extra asterisk in the comment start sequence, e.g.:
The next alternative is to use the Qt style and add an exclamation mark (!) after the opening sequence of a C-style comment block:
A third alternative is to use a block of at least two C++ comment lines, where each line starts with an additional slash or an exclamation mark:
or
Some people like to make their comment blocks more visible in the documentation. For this purpose you can use the following:
Note the 2 slashes to end the normal comment block and start a special comment block.
To structure and fomat the generated documentation, Doxygen provides a large number (> 170) of special commands. All commands in the documentation start with a backslash () or an at-sign (@).
For example
Lastpass login chrome. is equivalent to
For the brief description there are also several possibilities:
One could use the
brief
command with one of the above comment blocks. This command ends at the end of a paragraph, so the detailed description follows after an empty line.If
JAVADOC_AUTOBRIEF
is set to YES
in the configuration file, then using JavaDoc style comment blocks will automatically start a brief description which ends at the first dot followed by a space or new line.And finally here an example for a full documentation of a function with doxygen:
source and more info on the Doxygen homepage
Installation or Setup
Detailed instructions on getting doxygen set up or installed.