More docs.

src/CommonMetrics.h

@@ -1,5 +1,3 @@
-/** @brief CommonMetrics - Definitions of metrics that are in the "Common" group */
-
 #ifndef COMMON_METRICS_H
 #define COMMON_METRICS_H
 
@@ -42,7 +40,10 @@ private:
 };
 
 
-/** @brief The common metrics that are used throughout. */
+/** 
+ * @brief Definitions of metrics that are in the "Common" group.
+ *
+ * These metrics are used throughout the metrics file. */
 namespace CommonMetrics
 {
 	/** @brief The first screen in the attract loop. */

src/GameState.h

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

src/PlayerOptions.h

@@ -76,14 +76,15 @@ public:
 		APPEARANCE_RANDOMVANISH, /**< The arrows disappear, and then reappear in a different column. */
 		NUM_APPEARANCES
 	};
+	/** @brief The various turn mods. */
 	enum Turn {
-		TURN_NONE=0,
+		TURN_NONE=0, /**< No turning of the arrows is performed. */
-		TURN_MIRROR,
+		TURN_MIRROR, /**< The arrows are mirrored from their normal position. */
-		TURN_LEFT,
+		TURN_LEFT, /**< The arrows are turned 90 degrees to the left. */
-		TURN_RIGHT,
+		TURN_RIGHT, /**< The arrows are turned 90 degress to the right. */
-		TURN_SHUFFLE,
+		TURN_SHUFFLE, /**< Some of the arrow columns are changed throughout the whole song. */
-		TURN_SOFT_SHUFFLE,
+		TURN_SOFT_SHUFFLE, /**< Only shuffle arrow columns on an axis of symmetry. */
-		TURN_SUPER_SHUFFLE,
+		TURN_SUPER_SHUFFLE, /**< Every arrow is placed on a random column. */
 		NUM_TURNS 
 	};
 	enum Transform {

src/RadarValues.h

@@ -1,5 +1,3 @@
-/** @brief RadarValues - Cached song statistics. */
-
 #ifndef RARAR_VALUES_H
 #define RARAR_VALUES_H
 
@@ -11,7 +9,7 @@
 
 class XNode;
 struct lua_State;
-/** @brief The collection of radar values. */
+/** @brief Cached song statistics. */
 struct RadarValues
 {
 	union Values

src/SongManager.h

@@ -1,5 +1,3 @@
-/** @brief SongManager - Holder for all Songs and Steps. */
-
 #ifndef SONGMANAGER_H
 #define SONGMANAGER_H
 
@@ -143,7 +141,9 @@ protected:
 	void AddGroup( RString sDir, RString sGroupDirName );
 	int GetNumEditsLoadedFromProfile( ProfileSlot slot ) const;
 
-	vector<Song*>		m_pSongs;	// all songs that can be played
+	/** @brief All of the songs that can be played. */
+	vector<Song*>		m_pSongs;
+	/** @brief The most popular songs ranked by number of plays. */
 	vector<Song*>		m_pPopularSongs;
 	//vector<Song*>		m_pRecentSongs;	// songs recently played on the machine
 	vector<Song*>		m_pShuffledSongs;	// used by GetRandomSong