aboutsummaryrefslogtreecommitdiffhomepage
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorGravatar darkf <lw9k123@gmail.com>2014-12-29 19:47:41 -0800
committerGravatar darkf <lw9k123@gmail.com>2014-12-29 19:47:41 -0800
commit8ba9ac0f74abb0408a26207a76a0c1808bad8de0 (patch)
treef1c7c3393fa726435b5b90bf335567c93e528ef1 /CONTRIBUTING.md
parenta19354acedbfeafd28219c48a1ec32f76dd17a54 (diff)
parent3d14eb285382740b144e5b047cb2ad072f6129ea (diff)
Fix merge conflicts
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md1
1 files changed, 1 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 82b66be7..c8c8e388 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -27,6 +27,7 @@ Follow the indentation/whitespace style shown below. Do not use tabs, use 4-spac
### Comments
* For regular comments, use C++ style (`//`) comments, even for multi-line ones.
* For doc-comments (Doxygen comments), use `/// ` if it's a single line, else use the `/**` `*/` style featured in the example. Start the text on the second line, not the first containing `/**`.
+* For items that are both defined and declared in two separate files, put the doc-comment only next to the associated declaration. (In a header file, usually.) Otherwise, put it next to the implementation. Never duplicate doc-comments in both places.
```cpp
namespace Example {