doxygen and better fail message.

Hmm..why does GetCharacters not return
the DefaultCharacter? Is this function perhaps misnamed?
This commit is contained in:
Jason Felds
2011-07-05 22:57:01 -04:00
parent e281ca418b
commit ef31eca4c1
2 changed files with 8 additions and 3 deletions
+1 -1
View File
@@ -89,7 +89,7 @@ Character* CharacterManager::GetDefaultCharacter()
} }
/* We always have the default character. */ /* We always have the default character. */
ASSERT(0); FAIL_M("There must be a default character available!");
return NULL; return NULL;
} }
+7 -2
View File
@@ -1,19 +1,24 @@
/* CharacterManager - Manage characters. */
#ifndef CHARACTER_MANAGER_H #ifndef CHARACTER_MANAGER_H
#define CHARACTER_MANAGER_H #define CHARACTER_MANAGER_H
class Character; class Character;
struct lua_State; struct lua_State;
/** @brief Manage all of the Characters. */
class CharacterManager class CharacterManager
{ {
public: public:
/** @brief Set up the character manager. */
CharacterManager(); CharacterManager();
/** @brief Destroy the character manager. */
~CharacterManager(); ~CharacterManager();
void GetCharacters( vector<Character*> &vpCharactersOut ); void GetCharacters( vector<Character*> &vpCharactersOut );
/** @brief Get one installed character at random.
* @return The random character. */
Character* GetRandomCharacter(); Character* GetRandomCharacter();
/** @brief Get the character assigned as the default.
* @return The default character. */
Character* GetDefaultCharacter(); Character* GetDefaultCharacter();
Character* GetCharacterFromID( RString sCharacterID ); Character* GetCharacterFromID( RString sCharacterID );