From b01252d280b13de9732a0095f7cbf85ed9068aa1 Mon Sep 17 00:00:00 2001 From: Loek Le Blansch Date: Wed, 18 Dec 2024 14:23:34 +0100 Subject: update ScriptSystem doxygen --- src/crepe/system/ScriptSystem.h | 27 +++++++++++---------------- 1 file changed, 11 insertions(+), 16 deletions(-) diff --git a/src/crepe/system/ScriptSystem.h b/src/crepe/system/ScriptSystem.h index 095515f..cb214bd 100644 --- a/src/crepe/system/ScriptSystem.h +++ b/src/crepe/system/ScriptSystem.h @@ -11,31 +11,26 @@ class Script; /** * \brief Script system * - * The script system is responsible for all \c BehaviorScript components, and - * calls the methods on classes derived from \c Script. + * The script system is responsible for all \c BehaviorScript components, and calls the methods + * on classes derived from \c Script. */ class ScriptSystem : public System { public: using System::System; - /** - * \brief Call Script::fixed_update() on all active \c BehaviorScript instances - * - * This routine updates all scripts sequentially using the Script::update() - * method. It also calls Script::init() if this has not been done before on - * the \c BehaviorScript instance. - */ + +public: + //! Call Script::fixed_update() on all active \c BehaviorScript instances void fixed_update() override; + //! Call Script::frame_update() on all active \c BehaviorScript instances + void frame_update() override; +private: /** - * \brief Call Script::frame_update() on all active \c BehaviorScript instances + * \brief Call Script `*_update` member function on all active \c BehaviorScript instances * - * This routine updates all scripts sequentially using the Script::update() - * method. It also calls Script::init() if this has not been done before on - * the \c BehaviorScript instance. + * \note This routine also calls Script::init() if this has not been done before on the \c + * BehaviorScript instance. */ - void frame_update() override; - -private: void update(void (Script::*update_function)(duration_t), const duration_t & delta_time); }; -- cgit v1.2.3