diff options
| author |  Yuri Kunde Schlesner | 2014-12-04 04:47:52 -0200 |
|---|---|---|
| committer | Yuri Kunde Schlesner | 2014-12-04 04:47:52 -0200 |
| commit | 43f7f37d93365dee709c1f54286d9f21ca546eab (patch) | |
| tree | 441dd29f7fb2bd7097e978c112a60d5179f45d3d | |
| parent | Merge pull request #249 from lioncash/enum (diff) | |
| download | yuzu-43f7f37d93365dee709c1f54286d9f21ca546eab.tar.gz yuzu-43f7f37d93365dee709c1f54286d9f21ca546eab.tar.xz yuzu-43f7f37d93365dee709c1f54286d9f21ca546eab.zip | |
Resolve doxycomment duplication debate
I believe putting comments in the headers has won by a good margin, with everyone other than me preferring it, so time to enshrine it.
| -rw-r--r-- | CONTRIBUTING.md | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 82b66be75..c8c8e3884 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 | |||
| 27 | ### Comments | 27 | ### Comments |
| 28 | * For regular comments, use C++ style (`//`) comments, even for multi-line ones. | 28 | * For regular comments, use C++ style (`//`) comments, even for multi-line ones. |
| 29 | * 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 `/**`. | 29 | * 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 `/**`. |
| 30 | * 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. | ||
| 30 | 31 | ||
| 31 | ```cpp | 32 | ```cpp |
| 32 | namespace Example { | 33 | namespace Example { |