blob: 6cceeb696f2c91a8e7643ae44895964d4d94b477 (
plain)
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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
|
#include <iostream>
#include "some_other_header.hpp"
/** DOC
* @type function
* @name some_random_function
*
* @param input * data
* the input data for processing
*
* @return output
*
* @description
* Here you have the function description.
* It is allowed to have multiple lines.
* Isn't that cool?
*/
output some_random_function(input * data) {
output some_value;
/** TODO
* @category not_finished
*
* @description
* This is the description of
* the task which is not yet finished
*/
return some_value;
}
/** DOC
* @type class
* @name TheBestClass
*
* @description
* This class handles everything and is because of
* that very bloated but I am as every other programmer
* too lazy to fix this, so not my problem.
*/
class TheBestClass {
public:
TheBestClass();
void do_everithing();
}
/** DOC
* @type method
* @name TheBestClass::TheBestClass
*
* @description
* This is the initializer for
* TheBestClass it does nothing.
*/
TheBestClass::TheBestClass() {
}
/** DOC
* @type method
* @name TheBestClass::do_everything
*
* @return void
*
* @description
* This is the function do_everything
* it does everything what this class does.
* Because of this case this function is so
* mal-formed and you cannot understand it.
*/
void TheBestClass::do_everything() {
}
/** TODO
* @category some_bug
*
* @description
* Some weared bug lol
* what is this???
*/
void some_weard_fun() {
}
/** TODO
* @category not_finished
*
* @description
* This thing is not finished yet.
* why?
*/
int other_thing(int a, int b) {
}
|
