diff options
| author | Mattes D <github@xoft.cz> | 2014-06-01 10:43:37 +0200 |
|---|---|---|
| committer | Mattes D <github@xoft.cz> | 2014-06-01 10:43:37 +0200 |
| commit | 2059944d1e39e952c164b8a87c0c3f216b3b731e (patch) | |
| tree | fd210c1cf1bfcda2f7ed1292df01a26f9555c057 /CONTRIBUTING.md | |
| parent | Initial commit of the Generator article. (diff) | |
| parent | Updated AlchemistVillage prefabs. (diff) | |
| download | cuberite-2059944d1e39e952c164b8a87c0c3f216b3b731e.tar cuberite-2059944d1e39e952c164b8a87c0c3f216b3b731e.tar.gz cuberite-2059944d1e39e952c164b8a87c0c3f216b3b731e.tar.bz2 cuberite-2059944d1e39e952c164b8a87c0c3f216b3b731e.tar.lz cuberite-2059944d1e39e952c164b8a87c0c3f216b3b731e.tar.xz cuberite-2059944d1e39e952c164b8a87c0c3f216b3b731e.tar.zst cuberite-2059944d1e39e952c164b8a87c0c3f216b3b731e.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` |