aboutsummaryrefslogtreecommitdiff
path: root/contributing.md
diff options
context:
space:
mode:
authorLoek Le Blansch <loek@pipeframe.xyz>2024-11-11 15:52:43 +0100
committerLoek Le Blansch <loek@pipeframe.xyz>2024-11-11 15:52:43 +0100
commit656df6ddd6b5231705798540c347efeebf8ac8a9 (patch)
treeb26f5dc4210e437d46acc0995756903f6427f8f0 /contributing.md
parent3a690f7d0c91b92b9cdfe62f44dba8db90142abc (diff)
update contributing.md
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