From b5f99522c72759149ddb1888815abc3739db84e6 Mon Sep 17 00:00:00 2001 From: Marc Zinnschlag Date: Thu, 21 Nov 2013 12:29:24 +0100 Subject: [PATCH] added a few comments --- apps/openmw/mwbase/statemanager.hpp | 4 ++++ apps/openmw/mwstate/statemanagerimp.hpp | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/apps/openmw/mwbase/statemanager.hpp b/apps/openmw/mwbase/statemanager.hpp index 3369fd3bc..3bd99c315 100644 --- a/apps/openmw/mwbase/statemanager.hpp +++ b/apps/openmw/mwbase/statemanager.hpp @@ -63,8 +63,12 @@ namespace MWBase /// \note \a slot must belong to \a character. virtual MWState::Character *getCurrentCharacter() = 0; + ///< \attention Do not call this function to check if there is a current character. Use + /// characterBegin()!=characterEnd() instead. virtual CharacterIterator characterBegin() = 0; + ///< Any call to SaveGame and getCurrentCharacter can invalidate the returned + /// iterator. virtual CharacterIterator characterEnd() = 0; }; diff --git a/apps/openmw/mwstate/statemanagerimp.hpp b/apps/openmw/mwstate/statemanagerimp.hpp index d387404cb..08b0776c1 100644 --- a/apps/openmw/mwstate/statemanagerimp.hpp +++ b/apps/openmw/mwstate/statemanagerimp.hpp @@ -43,8 +43,12 @@ namespace MWState /// \note \a slot must belong to \a character. virtual Character *getCurrentCharacter(); + ///< \attention Do not call this function to check if there is a current character. Use + /// characterBegin()!=characterEnd() instead. virtual CharacterIterator characterBegin(); + ///< Any call to SaveGame and getCurrentCharacter can invalidate the returned + /// iterator. virtual CharacterIterator characterEnd(); };