summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorMattes D <github@xoft.cz>2014-05-13 08:48:33 +0200
committerMattes D <github@xoft.cz>2014-05-13 08:48:33 +0200
commit0685fb5258c6e4bdca310a3d22f8f997a2a556bb (patch)
tree3c14043e37c8c3c9e48eaf5a500249495ec058f9 /CONTRIBUTING.md
parentMerge pull request #999 from mc-server/fixes (diff)
downloadcuberite-0685fb5258c6e4bdca310a3d22f8f997a2a556bb.tar
cuberite-0685fb5258c6e4bdca310a3d22f8f997a2a556bb.tar.gz
cuberite-0685fb5258c6e4bdca310a3d22f8f997a2a556bb.tar.bz2
cuberite-0685fb5258c6e4bdca310a3d22f8f997a2a556bb.tar.lz
cuberite-0685fb5258c6e4bdca310a3d22f8f997a2a556bb.tar.xz
cuberite-0685fb5258c6e4bdca310a3d22f8f997a2a556bb.tar.zst
cuberite-0685fb5258c6e4bdca310a3d22f8f997a2a556bb.zip
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md2
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`