More doxy.

src/SpecialFiles.h

@@ -1,5 +1,3 @@
-/* SpecialFiles -  */
-
 #ifndef SpecialFiles_H
 #define SpecialFiles_H
 
@@ -19,8 +17,11 @@ namespace SpecialFiles
 	extern const RString PACKAGES_DIR;
 	extern const RString KEYMAPS_PATH;
 	extern const RString PREFERENCES_INI_PATH;
+	/** @brief The directory that contains the themes. */
 	extern const RString THEMES_DIR;
+	/** @brief The directory that contains the different languages. */
 	extern const RString LANGUAGES_SUBDIR;
+	/** @brief The base language for most users of this program. */
 	extern const RString BASE_LANGUAGE;
 	extern const RString METRICS_FILE;
 	extern const RString CACHE_DIR;
@@ -28,8 +29,11 @@ namespace SpecialFiles
 	extern const RString DEFAULTS_INI_PATH;
 	extern const RString STATIC_INI_PATH;
 	extern const RString TYPE_TXT_FILE;
+	/** @brief The default Songs directory. */
 	extern const RString SONGS_DIR;
+	/** @brief The default courses directory. */
 	extern const RString COURSES_DIR;
+	/** @brief The default noteskins directory. */
 	extern const RString NOTESKINS_DIR;
 }
 

src/Sprite.h

@@ -1,5 +1,3 @@
-/** @brief Sprite - A bitmap Actor that animates and moves around. */
-
 #ifndef SPRITE_H
 #define SPRITE_H
 
@@ -7,7 +5,7 @@
 #include "RageTextureID.h"
 
 class RageTexture;
-
+/** @brief A bitmap Actor that animates and moves around. */
 class Sprite: public Actor
 {
 public:

src/StageStats.h

@@ -17,7 +17,14 @@ public:
 	StageStats();
 	void Init();
 
+	/**
+	 * @brief Ensure that the Player is valid.
+	 * @param pn the PlayerNumber to check. */
 	void AssertValid( PlayerNumber pn ) const;
+	
+	/**
+	 * @brief Ensure that the Player is valid.
+	 * @param mp the Multiplayer to check. */
 	void AssertValid( MultiPlayer mp ) const;
 
 	void AddStats( const StageStats& other );		// accumulate
@@ -34,6 +41,7 @@ public:
 	vector<Song*>	m_vpPlayedSongs;
 	vector<Song*>	m_vpPossibleSongs;
 
+	/** @brief Was an extra stage earned this goaround? */
 	EarnedExtraStage m_EarnedExtraStage;
 	/** @brief Was the gameplay exited by the Player giving up? */
 	bool	m_bGaveUp;

src/TimingData.h

@@ -1,5 +1,3 @@
-/** @brief TimingData - Holds data for translating beats<->seconds. */
-
 #ifndef TIMING_DATA_H
 #define TIMING_DATA_H
 
@@ -479,7 +477,7 @@ struct TickcountSegment
 	bool operator>=( const TickcountSegment &other ) const { return !operator<(other); }
 };
 /**
- * @brief Houses all of the TimingData functions.
+ * @brief Holds data for translating beats<->seconds.
  */
 class TimingData
 {

src/TitleSubstitution.h

@@ -1,8 +1,7 @@
-/* TitleSubst - automatic translation for song titles */
-
 #ifndef TITLE_SUBSTITUTION_H
-#define TITLE_SUBSTITUTION_H 1
+#define TITLE_SUBSTITUTION_H
 
+/** @brief The different fields to potentially translate. */
 struct TitleFields
 {
 	void SaveToStrings( 
@@ -32,7 +31,7 @@ struct TitleFields
 	RString TitleTranslit, SubtitleTranslit, ArtistTranslit;
 };
 struct TitleTrans;
-
+/** @brief Automatic translation for Song titles. */
 class TitleSubst
 {
 	vector<TitleTrans *> ttab;
@@ -49,8 +48,10 @@ public:
 
 #endif
 
-/*
- * (c) 2003-2004 Glenn Maynard
+/**
+ * @file
+ * @author Glenn Maynard (c) 2003-2004
+ * @section LICENSE
  * All rights reserved.
  * 
  * Permission is hereby granted, free of charge, to any person obtaining a