diff options
author | bunnei <bunneidev@gmail.com> | 2014-11-23 22:57:24 +0100 |
---|---|---|
committer | bunnei <bunneidev@gmail.com> | 2014-11-23 22:57:24 +0100 |
commit | 3b65cfabfe79f09393bf350ed5e5cf0a1bbab6f7 (patch) | |
tree | e21f533eeaeca6edc91b10dc7248365f84aa769f | |
parent | Merge pull request #190 from purpasmart96/more_services (diff) | |
parent | Update CONTRIBUTING.md (diff) | |
download | yuzu-3b65cfabfe79f09393bf350ed5e5cf0a1bbab6f7.tar yuzu-3b65cfabfe79f09393bf350ed5e5cf0a1bbab6f7.tar.gz yuzu-3b65cfabfe79f09393bf350ed5e5cf0a1bbab6f7.tar.bz2 yuzu-3b65cfabfe79f09393bf350ed5e5cf0a1bbab6f7.tar.lz yuzu-3b65cfabfe79f09393bf350ed5e5cf0a1bbab6f7.tar.xz yuzu-3b65cfabfe79f09393bf350ed5e5cf0a1bbab6f7.tar.zst yuzu-3b65cfabfe79f09393bf350ed5e5cf0a1bbab6f7.zip |
Diffstat (limited to '')
-rw-r--r-- | CONTRIBUTING.md | 15 |
1 files changed, 12 insertions, 3 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 302afe216..82b66be75 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,6 +24,10 @@ Citra is a brand new project, so we have a great opportunity to keep things clea ### Indentation/Whitespace Style Follow the indentation/whitespace style shown below. Do not use tabs, use 4-spaces instead. +### 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 `/**`. + ```cpp namespace Example { @@ -33,12 +37,17 @@ namespace Example { int g_foo = 0; char* g_some_pointer; // Notice the position of the * +/// A colorful enum. enum SomeEnum { - COLOR_RED, - COLOR_GREEN, - COLOR_BLUE + COLOR_RED, ///< The color of fire. + COLOR_GREEN, ///< The color of grass. + COLOR_BLUE ///< Not actually the color of water. }; +/** + * Very important struct that does a lot of stuff. + * Note that the asterisks are indented by one space. + */ struct Position { int x, y; }; |