1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
|
# Comment Syntax
## Supported Doxygen Comment Styles
We're supporting the following Doxygen comment styles (see also
[Doxygen: Comment Blocks for C-Style Languages](https://doxygen.nl/manual/docblocks.html#cppblock)).
### Triple-Slashes
```cpp
/// @brief brings the unicorns back
///
/// It does that with an extraordinary special top secret device of extraterrestrial origin.
void bring_the_unicorns_back();
```
### Javadoc
```cpp
/**
* @brief brings the unicorns back
*
* It does that with an extraordinary special top secret device of extraterrestrial origin.
*/
void bring_the_unicorns_back();
```
or
```cpp
/**
@brief brings the unicorns back
It does that with an extraordinary special top secret device of extraterrestrial origin.
*/
void bring_the_unicorns_back();
```
### Qt
```cpp
/*!
* @brief brings the unicorns back
*
* It does that with an extraordinary special top secret device of extraterrestrial origin.
*/
void bring_the_unicorns_back();
```
or
```cpp
/*!
@brief brings the unicorns back
It does that with an extraordinary special top secret device of extraterrestrial origin.
*/
void bring_the_unicorns_back();
```
### Double-Slashes-With-Exclamation-Marks
```cpp
//! @brief brings the unicorns back
//!
//! It does that with an extraordinary special top secret device of extraterrestrial origin.
void bring_the_unicorns_back();
```
|
