added a few comments

This commit is contained in:
Marc Zinnschlag 2013-11-21 12:29:24 +01:00
parent c165894869
commit b5f99522c7
2 changed files with 8 additions and 0 deletions

View file

@ -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;
};

View file

@ -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();
};