-
Notifications
You must be signed in to change notification settings - Fork 1
/
doxygen-example.h
60 lines (49 loc) · 1.99 KB
/
doxygen-example.h
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
#ifndef DOXYGEN_EXAMPLE_H
#define DOXYGEN_EXAMPLE_H
#include "custom/class.h"
#include <QStandard>
//! \file doxygen-example.h
//! \ingroup NetSimDoxygenExample
//! \brief Contains the DoxygenExample class definition.
namespace NetSim {
//! \defgroup NetSimDoxygenExample NetSim DoxygenExample
//! \brief Provides an example of how to write doxumentation for classes
/**
* @class DoxygenExample
* @ingroup NetSimDoxygenExample
* @brief An example class to showcase how a class should be documented with the doxygen documentation language
*
* The DoxygenExample class normalizes the documentation and structuring of classes.
* While every Class should have a documentation like this one, there can be some occurences
* that are not showcased in this example, that need to be handled on their own. DoxygenExample inherits from Example...
*/
class DoxygenExample : public Example {
public:
//! @brief Default Constructor.
DoxygenExample() = default;
/**
* @brief Constructor that initializes the example with a randomAttribute and the fact if it is custom.
*
* @param randomAttribute Description of the attribute that is very random.
* @param customAttribute The fact if the instance is custom.
*/
explicit DoxygenExample(const void &randomAttribute, const void &customAttribute);
//! Simple Getter, Setter only need one line documentation
void randomAttribute() const;
/**
* @brief A brief description about this function
*
* @param randomParam Describe what the parameter is used for.
* @retval bool A random bool value that gets generated by the m_customAttribute.
*
* This function generates a random value of some shit and does some shit and random and more...
*/
bool randomFunction(void randomParam) const;
private:
//! @brief The void which stores some random things.
void m_randomAttribute;
//! @brief Indicates if the DoxygenExample is custom.
void m_customAttribute;
};
}
#endif DOXYGEN_EXAMPLE_H