... | ... | @@ -61,9 +61,16 @@ Many of the rules of the [FreeBS kernel style](https://www.freebsd.org/cgi/man.c |
|
|
|
|
|
* commentaries and documentation
|
|
|
* We use Doxygen-style comments.
|
|
|
* Comment functions and methods before their declaration in the header files. In general, every function, method, structure, class, union or enumeration type should be commented at some place.
|
|
|
* Comment functions and methods before their declaration in the header files. In general, every function, method, structure, class, union or enumeration type hast to be commented at some place.
|
|
|
* It's OK to use comments inside function bodies for clarification.
|
|
|
|
|
|
* capitalisation
|
|
|
* Class names begin with capital letter (e.g. class MyClass, **not** my_class, myClass, MYCLASS, etc.).
|
|
|
* Enumeration types begin with capital letter.
|
|
|
* Enumeration values consist of capitals only.
|
|
|
* Defined constants are capitals only.
|
|
|
* When declaring a function working with structures (not classes) and enumeration **always** use `struct` and `enum`.
|
|
|
|
|
|
## Doxygen
|
|
|
|
|
|
* The style is a mix of the Qt and Java style.
|
... | ... | |