aboutsummaryrefslogtreecommitdiff
path: root/src/crepe/manager
diff options
context:
space:
mode:
authorLoek Le Blansch <loek@pipeframe.xyz>2024-11-28 13:13:54 +0100
committerLoek Le Blansch <loek@pipeframe.xyz>2024-11-28 13:13:54 +0100
commit7a07c56d572a6f30d0aa611bd566197bc04c3b33 (patch)
tree75a5c234c48dad5c35d4773409bd6efcd4514dc3 /src/crepe/manager
parent63bce3dd21c82e2b4e45c07934d5a26684cdaa93 (diff)
add more documentation to Mediator + fix system mediator use
Diffstat (limited to 'src/crepe/manager')
-rw-r--r--src/crepe/manager/Mediator.h6
1 files changed, 5 insertions, 1 deletions
diff --git a/src/crepe/manager/Mediator.h b/src/crepe/manager/Mediator.h
index ce35d5c..a91509e 100644
--- a/src/crepe/manager/Mediator.h
+++ b/src/crepe/manager/Mediator.h
@@ -17,7 +17,11 @@ class SceneManager;
* pass specific references through dependency injection. All references on this struct
* *should* be explicitly checked for availability as this struct does not guarantee anything.
*
- * \todo Find better solution
+ * \note Dereferencing members of this struct should be deferred. If you are a user of this
+ * class, keep a reference to this mediator instead of just picking references from it when you
+ * receive an instance.
+ *
+ * \warning This class should never be directly accessible from the API
*/
struct Mediator {
OptionalRef<ComponentManager> component_manager;