Quick doxygens.

This commit is contained in:
Jason Felds
2011-02-19 02:10:45 -05:00
parent ffc466bec7
commit 1fd81cfe9c
9 changed files with 11 additions and 21 deletions
+1 -3
View File
@@ -1,12 +1,10 @@
/* ActorProxy - renders another actor. */
#ifndef ACTOR_PROXY_H #ifndef ACTOR_PROXY_H
#define ACTOR_PROXY_H #define ACTOR_PROXY_H
#include "Actor.h" #include "Actor.h"
struct lua_State; struct lua_State;
/** @brief Rendrs another actor. */
class ActorProxy: public Actor class ActorProxy: public Actor
{ {
public: public:
+1 -2
View File
@@ -1,5 +1,3 @@
/* ActorUtil - Utility functions for creating and manipulating Actors. */
#ifndef ActorUtil_H #ifndef ActorUtil_H
#define ActorUtil_H #define ActorUtil_H
@@ -43,6 +41,7 @@ enum FileType
}; };
const RString& FileTypeToString( FileType ft ); const RString& FileTypeToString( FileType ft );
/** @brief Utility functions for creating and manipulating Actors. */
namespace ActorUtil namespace ActorUtil
{ {
// Every screen should register its class at program initialization. // Every screen should register its class at program initialization.
+1 -3
View File
@@ -1,11 +1,9 @@
/* CourseContentsList - Holds course name and banner. */
#ifndef COURSE_CONTENTS_LIST_H #ifndef COURSE_CONTENTS_LIST_H
#define COURSE_CONTENTS_LIST_H #define COURSE_CONTENTS_LIST_H
#include "ActorScroller.h" #include "ActorScroller.h"
class CourseEntryDisplay; class CourseEntryDisplay;
/** @brief Holds course name and banner. */
class CourseContentsList : public ActorScroller class CourseContentsList : public ActorScroller
{ {
public: public:
+1 -1
View File
@@ -1,7 +1,7 @@
/* FontCharAliases - Provides support for nonstandard characters in text. */
#ifndef FONT_CHAR_ALIASES #ifndef FONT_CHAR_ALIASES
#define FONT_CHAR_ALIASES #define FONT_CHAR_ALIASES
/** @brief Provides support for nonstandard characters in text. */
namespace FontCharAliases namespace FontCharAliases
{ {
void ReplaceMarkers( RString &sText ); void ReplaceMarkers( RString &sText );
+1 -3
View File
@@ -1,5 +1,3 @@
/* GameSoundManager - High-level sound utilities. */
#ifndef RAGE_SOUNDS_H #ifndef RAGE_SOUNDS_H
#define RAGE_SOUNDS_H #define RAGE_SOUNDS_H
@@ -8,7 +6,7 @@
class TimingData; class TimingData;
class RageSound; class RageSound;
struct lua_State; struct lua_State;
/** @brief High-level sound utilities. */
class GameSoundManager class GameSoundManager
{ {
public: public:
+1 -3
View File
@@ -1,5 +1,3 @@
/* LifeMeterBattery - Battery life meter used in Oni mode. */
#ifndef LIFEMETERBATTERY_H #ifndef LIFEMETERBATTERY_H
#define LIFEMETERBATTERY_H #define LIFEMETERBATTERY_H
@@ -10,7 +8,7 @@
#include "PercentageDisplay.h" #include "PercentageDisplay.h"
#include "ThemeMetric.h" #include "ThemeMetric.h"
/** @brief Battery life meter used in Oni mode. */
class LifeMeterBattery : public LifeMeter class LifeMeterBattery : public LifeMeter
{ {
public: public:
+1 -3
View File
@@ -1,5 +1,3 @@
/* MemoryCardDisplay - A graphic displaying the state of memory cards. */
#ifndef MEMORY_CARD_DISPLAY_H #ifndef MEMORY_CARD_DISPLAY_H
#define MEMORY_CARD_DISPLAY_H #define MEMORY_CARD_DISPLAY_H
@@ -7,7 +5,7 @@
#include "PlayerNumber.h" #include "PlayerNumber.h"
#include "Sprite.h" #include "Sprite.h"
#include "ActorFrame.h" #include "ActorFrame.h"
/** @brief A graphic displaying the state of memory cards. */
class MemoryCardDisplay : public ActorFrame class MemoryCardDisplay : public ActorFrame
{ {
public: public:
+1 -2
View File
@@ -1,5 +1,3 @@
/* PercentageDisplay - An Actor that displays a percentage. */
#ifndef PERCENTAGE_DISPLAY_H #ifndef PERCENTAGE_DISPLAY_H
#define PERCENTAGE_DISPLAY_H #define PERCENTAGE_DISPLAY_H
@@ -11,6 +9,7 @@
class PlayerState; class PlayerState;
/** @brief An Actor that displays a percentage. */
class PercentageDisplay: public ActorFrame class PercentageDisplay: public ActorFrame
{ {
public: public:
+3 -1
View File
@@ -42,7 +42,9 @@
#include "LocalizedString.h" #include "LocalizedString.h"
#include "AdjustSync.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 class JudgedRows
{ {
vector<bool> m_vRows; vector<bool> m_vRows;