aboutsummaryrefslogtreecommitdiff
path: root/contributing.md
diff options
context:
space:
mode:
authormax-001 <maxsmits21@kpnmail.nl>2024-11-06 15:24:18 +0100
committermax-001 <maxsmits21@kpnmail.nl>2024-11-06 15:24:18 +0100
commit628b5d488e9f48db7926ce6b106345cd88157ce7 (patch)
tree8c9bf1d5aae198e3390f321300e23fe1abe43c54 /contributing.md
parent6296b85846b21083e4f545b209f1d9edce2b06f9 (diff)
parent4f953a35912c3d92c26bcb6c2cc77cc3ced176a3 (diff)
Merge remote-tracking branch 'origin/master' into max/big-cleanup
Diffstat (limited to 'contributing.md')
-rw-r--r--contributing.md14
1 files changed, 9 insertions, 5 deletions
diff --git a/contributing.md b/contributing.md
index e910dba..88cba32 100644
--- a/contributing.md
+++ b/contributing.md
@@ -49,11 +49,14 @@ that you can click on to open them.
class Cars {};
```
</td></tr></table></details>
-- Source files contain the following types of comments:
+- Source files (.cpp, .hpp) contain the following types of comments:
- What is the code supposed to do (optional)
- Implementation details (if applicable)
-- Header files contain the following types of comments:
+- Header files (.h) contain the following types of comments:
- Usage documentation (required)
+
+ > [!NOTE]
+ > Constructors/destructors aren't required to have a `\brief` description
- Implementation details (if they affect the header)
- Design/data structure decisions (if applicable)
- <details><summary>
@@ -110,7 +113,8 @@ that you can click on to open them.
```
</td></tr></table></details>
- <details><summary>
- <code>using namespace</code> may not be used in header files, only in source files.
+ <code>using namespace</code> may not be used in header files (.h, .hpp), only
+ in source files (.cpp).
</summary><table><tr><th>Good</th><th>Bad</th></tr><tr><td>
example.h:
@@ -277,7 +281,7 @@ that you can click on to open them.
```cpp
struct Foo {
- int bar;
+ int bar = 0;
std::string baz;
};
```
@@ -285,7 +289,7 @@ that you can click on to open them.
```cpp
struct Foo {
- int bar = 0;
+ int bar;
std::string baz;
};
```