From 74e45aa4324756fdab908f22abe9245699c66777 Mon Sep 17 00:00:00 2001
From: Jason Felds <jafelds@gmail.com>
Date: Fri, 18 Feb 2011 15:52:44 -0500
Subject: [PATCH] More doxygen.

---
 src/ScreenOptions.h | 26 +++++++++++++++-----------
 src/SpecialFiles.h  | 20 ++++++++++++++++----
 2 files changed, 31 insertions(+), 15 deletions(-)

diff --git a/src/ScreenOptions.h b/src/ScreenOptions.h
index e9ec4f93d7..8e23a14f00 100644
--- a/src/ScreenOptions.h
+++ b/src/ScreenOptions.h
@@ -1,4 +1,4 @@
-/* ScreenOptions - A grid of options; the selected option is drawn with a highlight rectangle. */
+/** @brief ScreenOptions - A grid of options; the selected option is drawn with a highlight rectangle. */
 
 #ifndef SCREENOPTIONS_H
 #define SCREENOPTIONS_H
@@ -16,15 +16,17 @@ class OptionRowHandler;
 
 AutoScreenMessage( SM_ExportOptions )
 
+/** @brief The list of input modes for the given row. */
 enum InputMode 
 { 
-	INPUTMODE_INDIVIDUAL,		// each player controls their own cursor
-	INPUTMODE_SHARE_CURSOR,		// both players control the same cursor
-	NUM_InputMode,
+	INPUTMODE_INDIVIDUAL,		/**< each player controls their own cursor */
+	INPUTMODE_SHARE_CURSOR,		/**< both players control the same cursor */
+	NUM_InputMode,			/**< The number of input modes available. */
 	InputMode_Invalid
 };
 InputMode StringToInputMode( const RString& str );
 
+/** @brief A custom foreach loop for the player options for each player. */
 #define FOREACH_OptionsPlayer( pn ) \
 	for( PlayerNumber pn=GetNextHumanPlayer((PlayerNumber)-1); pn!=PLAYER_INVALID && (m_InputMode==INPUTMODE_INDIVIDUAL || pn==0); pn=GetNextHumanPlayer(pn) )
 
@@ -112,12 +114,12 @@ protected:	// derived classes need access to these
 	ActorFrame		m_frameContainer;
 	AutoActor		m_sprPage;
 
-	OptionsCursor	m_Cursor[NUM_PLAYERS];
+	OptionsCursor		m_Cursor[NUM_PLAYERS];
 	AutoActor		m_sprLineHighlight[NUM_PLAYERS];
 
 	BitmapText		m_textExplanation[NUM_PLAYERS];
 	BitmapText		m_textExplanationTogether;
-	DualScrollBar	m_ScrollBar;
+	DualScrollBar		m_ScrollBar;
 	AutoActor		m_sprMore;
 
 	RageSound		m_SoundChangeCol;
@@ -131,7 +133,7 @@ protected:	// derived classes need access to these
 	ThemeMetric<apActorCommands>	ROW_INIT_COMMAND;
 	ThemeMetric<apActorCommands>	ROW_ON_COMMAND;
 	ThemeMetric<apActorCommands>	ROW_OFF_COMMAND;
-	LuaExpressionTransform	m_exprRowPositionTransformFunction;	// params: self,offsetFromCenter,itemIndex,numItems
+	LuaExpressionTransform		m_exprRowPositionTransformFunction;	// params: self,offsetFromCenter,itemIndex,numItems
 	ThemeMetric<bool>		SHOW_SCROLL_BAR;
 	ThemeMetric<float>		SCROLL_BAR_HEIGHT;
 	ThemeMetric<float>		SCROLL_BAR_TIME;
@@ -143,14 +145,16 @@ protected:	// derived classes need access to these
 	ThemeMetric<bool>		ALLOW_REPEATING_CHANGE_VALUE_INPUT;
 	ThemeMetric<float>		CURSOR_TWEEN_SECONDS;
 	ThemeMetric<bool>		WRAP_VALUE_IN_ROW;
-	ThemeMetric<RString>	OPTION_ROW_NORMAL_METRICS_GROUP;
-	ThemeMetric<RString>	OPTION_ROW_EXIT_METRICS_GROUP;
+	ThemeMetric<RString>		OPTION_ROW_NORMAL_METRICS_GROUP;
+	ThemeMetric<RString>		OPTION_ROW_EXIT_METRICS_GROUP;
 };
 
 #endif
 
-/*
- * (c) 2001-2004 Chris Danford, Glenn Maynard
+/**
+ * @file
+ * @author Chris Danford, Glenn Maynard (c) 2001-2004 
+ * @section LICENSE
  * All rights reserved.
  * 
  * Permission is hereby granted, free of charge, to any person obtaining a
diff --git a/src/SpecialFiles.h b/src/SpecialFiles.h
index 193de622a0..b8ef3faa5b 100644
--- a/src/SpecialFiles.h
+++ b/src/SpecialFiles.h
@@ -3,10 +3,20 @@
 #ifndef SpecialFiles_H
 #define SpecialFiles_H
 
+/** @brief The listing of the special files and directories in use. */
 namespace SpecialFiles
 {
-	extern const RString USER_PACKAGES_DIR;	// user packages should be a separate dir from system packages so that we can write to it (installing a package)
-	extern const RString PACKAGES_DIR;	// system packages (not user packages)
+	/**
+	 * @brief The user packages directory.
+	 *
+	 * This should be separate from system packages so that
+	 * we can write to it (installing a package).
+	 */
+	extern const RString USER_PACKAGES_DIR;
+	/** @brief The system packages directory.
+	 *
+	 * This is not the user packages directory. */
+	extern const RString PACKAGES_DIR;
 	extern const RString KEYMAPS_PATH;
 	extern const RString PREFERENCES_INI_PATH;
 	extern const RString THEMES_DIR;
@@ -25,8 +35,10 @@ namespace SpecialFiles
 
 #endif
 
-/*
- * (c) 2003-2005 Chris Danford
+/**
+ * @file
+ * @author Chris Danford (c) 2003-2005
+ * @section LICENSE
  * All rights reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a