diff options
author | heavydemon21 <nielsstunnebrink1@gmail.com> | 2024-09-06 09:41:13 +0200 |
---|---|---|
committer | heavydemon21 <nielsstunnebrink1@gmail.com> | 2024-09-06 09:41:13 +0200 |
commit | de77372027053744604cba732dce318159289b76 (patch) | |
tree | 1dfc2b81da65a508adfb62e60070addec9b75df7 /code-style-example/style.h | |
parent | d2376c9713445a98cee9a24cfeb1029d140d19f7 (diff) |
style code example added and added more examples in contributing.md
Diffstat (limited to 'code-style-example/style.h')
-rw-r--r-- | code-style-example/style.h | 58 |
1 files changed, 58 insertions, 0 deletions
diff --git a/code-style-example/style.h b/code-style-example/style.h new file mode 100644 index 0000000..2a4022b --- /dev/null +++ b/code-style-example/style.h @@ -0,0 +1,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 |