From 7a07c56d572a6f30d0aa611bd566197bc04c3b33 Mon Sep 17 00:00:00 2001 From: Loek Le Blansch Date: Thu, 28 Nov 2024 13:13:54 +0100 Subject: add more documentation to Mediator + fix system mediator use --- src/crepe/manager/Mediator.h | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) (limited to 'src/crepe/manager') 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 component_manager; -- cgit v1.2.3