aboutsummaryrefslogtreecommitdiff
path: root/contributing.md
diff options
context:
space:
mode:
authorLoek Le Blansch <loek@pipeframe.xyz>2024-11-12 15:11:51 +0100
committerLoek Le Blansch <loek@pipeframe.xyz>2024-11-12 15:11:51 +0100
commit33454c2c8d8c0abdfd405608af4e6cd53a25e7c4 (patch)
treeef5131afc629815e993775423602a6e8af5fcb5f /contributing.md
parent067247360d68042ad5466b802399338c14d7dc58 (diff)
parent656df6ddd6b5231705798540c347efeebf8ac8a9 (diff)
merge `master` into `loek/cleanup`
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