From 1fd81cfe9cb9db917c795f2224e563d0ddbeb409 Mon Sep 17 00:00:00 2001
From: Jason Felds <jafelds@gmail.com>
Date: Sat, 19 Feb 2011 02:10:45 -0500
Subject: [PATCH] Quick doxygens.

---
 src/ActorProxy.h         | 4 +---
 src/ActorUtil.h          | 3 +--
 src/CourseContentsList.h | 4 +---
 src/FontCharAliases.h    | 2 +-
 src/GameSoundManager.h   | 4 +---
 src/LifeMeterBattery.h   | 4 +---
 src/MemoryCardDisplay.h  | 4 +---
 src/PercentageDisplay.h  | 3 +--
 src/Player.cpp           | 4 +++-
 9 files changed, 11 insertions(+), 21 deletions(-)

diff --git a/src/ActorProxy.h b/src/ActorProxy.h
index c30b4d5a9a..2416c6e7b5 100644
--- a/src/ActorProxy.h
+++ b/src/ActorProxy.h
@@ -1,12 +1,10 @@
-/* ActorProxy - renders another actor. */
-
 #ifndef ACTOR_PROXY_H
 #define ACTOR_PROXY_H
 
 #include "Actor.h"
 
 struct lua_State;
-
+/** @brief Rendrs another actor. */
 class ActorProxy: public Actor
 {
 public:
diff --git a/src/ActorUtil.h b/src/ActorUtil.h
index 3d199bf1c9..bab0991a96 100644
--- a/src/ActorUtil.h
+++ b/src/ActorUtil.h
@@ -1,5 +1,3 @@
-/* ActorUtil - Utility functions for creating and manipulating Actors. */
-
 #ifndef ActorUtil_H
 #define ActorUtil_H
 
@@ -43,6 +41,7 @@ enum FileType
 };
 const RString& FileTypeToString( FileType ft );
 
+/** @brief Utility functions for creating and manipulating Actors. */
 namespace ActorUtil
 {
 	// Every screen should register its class at program initialization.
diff --git a/src/CourseContentsList.h b/src/CourseContentsList.h
index f0b38cbb04..7d11a09df4 100644
--- a/src/CourseContentsList.h
+++ b/src/CourseContentsList.h
@@ -1,11 +1,9 @@
-/* CourseContentsList - Holds course name and banner. */
-
 #ifndef COURSE_CONTENTS_LIST_H
 #define COURSE_CONTENTS_LIST_H
 
 #include "ActorScroller.h"
 class CourseEntryDisplay;
-
+/** @brief Holds course name and banner. */
 class CourseContentsList : public ActorScroller
 {
 public:
diff --git a/src/FontCharAliases.h b/src/FontCharAliases.h
index 299622b987..ebb694ab5c 100644
--- a/src/FontCharAliases.h
+++ b/src/FontCharAliases.h
@@ -1,7 +1,7 @@
-/* FontCharAliases - Provides support for nonstandard characters in text. */
 #ifndef FONT_CHAR_ALIASES
 #define FONT_CHAR_ALIASES
 
+/** @brief Provides support for nonstandard characters in text. */
 namespace FontCharAliases
 {
 	void ReplaceMarkers( RString &sText );
diff --git a/src/GameSoundManager.h b/src/GameSoundManager.h
index 49d321fece..df7b801d8b 100644
--- a/src/GameSoundManager.h
+++ b/src/GameSoundManager.h
@@ -1,5 +1,3 @@
-/* GameSoundManager - High-level sound utilities. */
-
 #ifndef RAGE_SOUNDS_H
 #define RAGE_SOUNDS_H
 
@@ -8,7 +6,7 @@
 class TimingData;
 class RageSound;
 struct lua_State;
-
+/** @brief High-level sound utilities. */
 class GameSoundManager
 {
 public:
diff --git a/src/LifeMeterBattery.h b/src/LifeMeterBattery.h
index ea5afc6fba..67a40cd99c 100644
--- a/src/LifeMeterBattery.h
+++ b/src/LifeMeterBattery.h
@@ -1,5 +1,3 @@
-/* LifeMeterBattery - Battery life meter used in Oni mode. */
-
 #ifndef LIFEMETERBATTERY_H
 #define LIFEMETERBATTERY_H
 
@@ -10,7 +8,7 @@
 #include "PercentageDisplay.h"
 #include "ThemeMetric.h"
 
-
+/** @brief Battery life meter used in Oni mode. */
 class LifeMeterBattery : public LifeMeter
 {
 public:
diff --git a/src/MemoryCardDisplay.h b/src/MemoryCardDisplay.h
index 3021aeb765..fcf478aedd 100644
--- a/src/MemoryCardDisplay.h
+++ b/src/MemoryCardDisplay.h
@@ -1,5 +1,3 @@
-/* MemoryCardDisplay - A graphic displaying the state of memory cards. */
-
 #ifndef MEMORY_CARD_DISPLAY_H
 #define MEMORY_CARD_DISPLAY_H
 
@@ -7,7 +5,7 @@
 #include "PlayerNumber.h"
 #include "Sprite.h"
 #include "ActorFrame.h"
-
+/** @brief A graphic displaying the state of memory cards. */
 class MemoryCardDisplay : public ActorFrame
 {
 public:
diff --git a/src/PercentageDisplay.h b/src/PercentageDisplay.h
index 9afcfd02bf..875b6ee664 100644
--- a/src/PercentageDisplay.h
+++ b/src/PercentageDisplay.h
@@ -1,5 +1,3 @@
-/* PercentageDisplay - An Actor that displays a percentage. */
-
 #ifndef PERCENTAGE_DISPLAY_H
 #define PERCENTAGE_DISPLAY_H
 
@@ -11,6 +9,7 @@
 
 class PlayerState;
 
+/** @brief An Actor that displays a percentage. */
 class PercentageDisplay: public ActorFrame
 {
 public:
diff --git a/src/Player.cpp b/src/Player.cpp
index 0be0925070..9e8a7c4d58 100644
--- a/src/Player.cpp
+++ b/src/Player.cpp
@@ -42,7 +42,9 @@
 #include "LocalizedString.h"
 #include "AdjustSync.h"
 
-// Helper class to ensure that each row is only judged once without taking too much memory.
+/**
+ * @brief Helper class to ensure that each row is only judged once without taking too much memory.
+ */
 class JudgedRows
 {
 	vector<bool> m_vRows;