More docs.

2011-02-27 21:36:34 -05:00
parent 91ee8831a9
commit d9a195d4c2
5 changed files with 20 additions and 16 deletions
@@ -115,6 +115,10 @@ public:
 	bool IsPlayerEnabled( const PlayerState* pPlayerState ) const;
 	int	GetNumPlayersEnabled() const;

+	/**
+	 * @brief Is the specified Player a human Player?
+	 * @param pn the numbered Player to check.
+	 * @return true if it's a human Player, or false otherwise. */
 	bool IsHumanPlayer( PlayerNumber pn ) const;
 	int GetNumHumanPlayers() const;
 	PlayerNumber GetFirstHumanPlayer() const;