diff options
Diffstat (limited to 'example.cpp')
| -rw-r--r-- | example.cpp | 98 |
1 files changed, 98 insertions, 0 deletions
diff --git a/example.cpp b/example.cpp new file mode 100644 index 0000000..6cceeb6 --- /dev/null +++ b/example.cpp @@ -0,0 +1,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) { +} |