aboutsummaryrefslogtreecommitdiff
path: root/contributing.md
diff options
context:
space:
mode:
authorWBoerenkamps <wrj.boerenkamps@student.avans.nl>2024-11-12 15:17:14 +0100
committerWBoerenkamps <wrj.boerenkamps@student.avans.nl>2024-11-12 15:17:14 +0100
commitd8ab8df9e61d908348a25d9556ec2e8c19656315 (patch)
tree77103a6b82ee65f165bc14058799e8bf6130195d /contributing.md
parent113e2d299d22921212a793eb7cd55afbd49ba22e (diff)
parent656df6ddd6b5231705798540c347efeebf8ac8a9 (diff)
Merge branch 'master' of https://github.com/lonkaars/crepe into wouter/LoopManager-new
Diffstat (limited to 'contributing.md')
-rw-r--r--contributing.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/contributing.md b/contributing.md
index 8799057..a80f2b4 100644
--- a/contributing.md
+++ b/contributing.md
@@ -652,6 +652,20 @@ that you can click on to open them.
bool bar = 0;
```
</td></tr></table></details>
+- <details><summary>
+ The reason for <code>friend</code> relations are documented
+ </summary><table><tr><th>Good</th><th>Bad</th></tr><tr><td>
+
+ ```cpp
+ //! ComponentManager calls the private constructor of this class
+ friend class ComponentManager;
+ ```
+ </td><td>
+
+ ```cpp
+ friend class ComponentManager;
+ ```
+ </td></tr></table></details>
## CMakeLists-specific