diff options
| author | Yuri Kunde Schlesner <[email protected]> | 2014-12-04 04:47:52 -0200 |
|---|---|---|
| committer | Yuri Kunde Schlesner <[email protected]> | 2014-12-04 04:47:52 -0200 |
| commit | 43f7f37d93365dee709c1f54286d9f21ca546eab (patch) | |
| tree | 441dd29f7fb2bd7097e978c112a60d5179f45d3d /CONTRIBUTING.md | |
| parent | 846dc72a37bb3651b8c40c9d474c381298aff902 (diff) | |
| download | yuzu-android-43f7f37d93365dee709c1f54286d9f21ca546eab.tar.gz yuzu-android-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.
Diffstat (limited to 'CONTRIBUTING.md')
| -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 ### 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 { |