diff options
| author | Tycho <work.tycho+git@gmail.com> | 2014-05-24 13:44:49 +0200 |
|---|---|---|
| committer | Tycho <work.tycho+git@gmail.com> | 2014-05-24 13:44:49 +0200 |
| commit | 4ab82881165cb180b020e67f851028718ab84d87 (patch) | |
| tree | 93e773ebd46fb76dd520821133b01f6d99b26e94 /CONTRIBUTING.md | |
| parent | Ignore CTest files (diff) | |
| parent | Merge pull request #1022 from mc-server/FixMineshafts (diff) | |
| download | cuberite-4ab82881165cb180b020e67f851028718ab84d87.tar cuberite-4ab82881165cb180b020e67f851028718ab84d87.tar.gz cuberite-4ab82881165cb180b020e67f851028718ab84d87.tar.bz2 cuberite-4ab82881165cb180b020e67f851028718ab84d87.tar.lz cuberite-4ab82881165cb180b020e67f851028718ab84d87.tar.xz cuberite-4ab82881165cb180b020e67f851028718ab84d87.tar.zst cuberite-4ab82881165cb180b020e67f851028718ab84d87.zip | |
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0c36be8b7..03481ec48 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -27,7 +27,7 @@ Code Stuff - The only exception: a `switch` statement with all `case` statements being a single short statement is allowed to use the short brace-less form. - These two rules really mean that indent is governed by braces * Add an empty last line in all source files (GCC and GIT can complain otherwise) - * Use doxy-comments for functions in the header file, format as `/** Description */` + * All new public functions in all classes need documenting comments on what they do and what behavior they follow, use doxy-comments formatted as `/** Description */`. Do not use asterisks on additional lines in multi-line comments. * Use spaces after the comment markers: `// Comment` instead of `//Comment` |