... | ... | @@ -4,6 +4,8 @@ Many of the rules of the [FreeBS kernel style](https://www.freebsd.org/cgi/man.c |
|
|
|
|
|
## Exceptions or Clarifications
|
|
|
|
|
|
* Source file names are all in lower case and use underscores for name separation.
|
|
|
|
|
|
* Every source code file starts with a copyright statement. The copyright date should be checked, when a file is edited, and adjusted to meet current date.
|
|
|
|
|
|
```c
|
... | ... | @@ -42,6 +44,13 @@ Many of the rules of the [FreeBS kernel style](https://www.freebsd.org/cgi/man.c |
|
|
* When working with a nested type a function or a method where the visibility of the typedef is local.
|
|
|
* Should a template if a template situation occur (e.g. to avoid errors when working with `foreach`).
|
|
|
|
|
|
* preprocessor statements
|
|
|
* We use `#ifndef _HEADER_FILE_H_` as header guards (for file header_file.h)
|
|
|
* The `#endif` statement is followed by comment specifying corresponding `#ifdef` or `#if` statement (i.e. #endif \* _HEADER_FILE_H_ *\)
|
|
|
* We use `#else` statements followed by a comment with the negation of the condition that leads to the else statement.
|
|
|
* We prefer C-style commentaries.
|
|
|
|
|
|
|
|
|
## Doxygen
|
|
|
|
|
|
* The style is a mix of the Qt and Java style.
|
... | ... | |