aboutsummaryrefslogtreecommitdiff
path: root/code-style-example/style.h
blob: 2a4022bce5afe43678b41e97810f8c151ebdf7b3 (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
/*! @file MyClass.h */

#ifndef MYPROJECT_MYCLASS_HPP
#define MYPROJECT_MYCLASS_HPP

/**
 * @brief example class
 */
class MyClass {

public:
	/**
	 * @brief example constructor
	 *
	 * @param[integer] t_value example first argument
	 */
	MyClass(int t_value);

	/**
	 * @brief constructor example
	 *
	 */
	MyClass();

	/**
	 * @brief deconstuctor example
	 *
	 */
	~MyClass();

	/**
	 * @brief setter example with correct const implementation
	 *
	 * @param[const integer] t_value first argument
	 */
	void set_value(const int t_value);

	/**
	 * @brief getter example with correct const implementation
	 *
	 * @return const integer
	 */
	const int get_value() const;

	/**
	 * @brief increment member m_value
	 *
	 */
	void increment();

private:
	/**
	 * @m_value basic member example
	 */
	int m_value;
};

#endif