... | ... | @@ -2,6 +2,35 @@ |
|
|
|
|
|
Many of the rules of the [FreeBS kernel style](https://www.freebsd.org/cgi/man.cgi?query=style&sektion=9) can be applied.
|
|
|
|
|
|
## Exceptions or Clarifications
|
|
|
|
|
|
* 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
|
|
|
/*
|
|
|
* Copyright (C) 2014-2016 CZ.NIC
|
|
|
*
|
|
|
* This program is free software: you can redistribute it and/or modify
|
|
|
* it under the terms of the GNU General Public License as published by
|
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
|
* (at your option) any later version.
|
|
|
*
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
* GNU General Public License for more details.
|
|
|
*
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
*
|
|
|
* In addition, as a special exception, the copyright holders give
|
|
|
* permission to link the code of portions of this program with the
|
|
|
* OpenSSL library under certain conditions as described in each
|
|
|
* individual source file, and distribute linked combinations including
|
|
|
* the two.
|
|
|
*/
|
|
|
```
|
|
|
|
|
|
## Doxygen
|
|
|
|
|
|
* The style is a mix of the Qt and Java style.
|
... | ... | @@ -17,7 +46,7 @@ Many of the rules of the [FreeBS kernel style](https://www.freebsd.org/cgi/man.c |
|
|
* return values
|
|
|
* todos
|
|
|
* Always use `@brief` (no autobrief).
|
|
|
* Indent text (using spaces only) in multiple-line sections
|
|
|
* 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.
|
... | ... | |