Self sign-up has been disabled due to increased spam activity. If you want to get access, please send an email to a project owner (preferred) or at gitlab(at)nic(dot)cz. We apologize for the inconvenience.
@@ -7,8 +7,27 @@ Many of the rules of the [FreeBS kernel style](https://www.freebsd.org/cgi/man.c
...
@@ -7,8 +7,27 @@ Many of the rules of the [FreeBS kernel style](https://www.freebsd.org/cgi/man.c
* The style is a mix of the Qt and Java style.
* The style is a mix of the Qt and Java style.
*`/*!`, not `/**`
*`/*!`, not `/**`
*`@brief`, not `\brief`
*`@brief`, not `\brief`
* order of sections:
* brief description
* long description
* notes
* warnings
* references
* parameters
* return values
* todos
* Always use `@brief` (no autobrief).
* Indent text (using spaces only) in multiple-line sections
* In multi-line comments, opening line (`/*!`) should be empty.
* One empty line between two consecutive sections.
* Structure and union members documented on the same line if the comment fits. This also applies to non-function non-method class members.
* Use `@return` for describing return values. Usage of `@retval` (or more of them) instead of `@return if the function returns some distinct values (such as 0 for no error, -1 for something else, etc.) is also encouraged.
* We don't use file comments currently.
* Every API function/method must have a comment containing at least: