More doc updates.

This commit is contained in:
Jason Felds
2011-02-19 17:22:53 -05:00
parent e9449cb50e
commit 05ce6c7773
5 changed files with 21 additions and 25 deletions
+1 -3
View File
@@ -1,11 +1,9 @@
/* LyricDisplay - Displays lyrics along with the song on Gameplay. */
#ifndef LYRIC_DISPLAY_H
#define LYRIC_DISPLAY_H
#include "ActorFrame.h"
#include "BitmapText.h"
/** @brief Displays lyrics along with the song on Gameplay. */
class LyricDisplay: public ActorFrame
{
public:
+1 -3
View File
@@ -1,5 +1,3 @@
/* OptionsCursor - A cursor for ScreenOptions. */
#ifndef OPTIONS_CURSOR_H
#define OPTIONS_CURSOR_H
@@ -7,7 +5,7 @@
#include "ActorFrame.h"
#include "PlayerNumber.h"
#include "AutoActor.h"
/** @brief A cursor for ScreenOptions. */
class OptionsCursor : public ActorFrame
{
public:
+7 -3
View File
@@ -7,7 +7,7 @@
class RageSoundResampler_Polyphase;
/* This class changes the sampling rate of a sound. */
/** @brief This class changes the sampling rate of a sound. */
class RageSoundReader_Resample_Good: public RageSoundReader_Filter
{
public:
@@ -22,10 +22,14 @@ public:
int GetNextSourceFrame() const;
float GetStreamToSourceRatio() const;
/* Change the rate of a sound without changing the sample rate. */
/**
* @brief Change the rate of a sound without changing the sample rate.
* @param fRatio the ratio for changing. */
void SetRate( float fRatio );
/* SetRate() will be rounded. Get the exact rate. */
/**
* @brief Retrieve the exact rate.
* @param the exact rate. */
float GetRate() const;
int GetSampleRate() const { return m_iSampleRate; }
+1 -3
View File
@@ -1,12 +1,10 @@
/* ScoreKeeperRave - Launches attacks in PLAY_MODE_RAVE. */
#ifndef SCORE_KEEPER_RAVE_H
#define SCORE_KEEPER_RAVE_H
#include "ScoreKeeper.h"
#include "GameConstantsAndTypes.h"
/** @Brief Launches attacks in PLAY_MODE_RAVE. */
class ScoreKeeperRave : public ScoreKeeper
{
public:
+11 -13
View File
@@ -1,5 +1,3 @@
/* WheelItemBase - An item on the wheel. */
#ifndef WHEEL_ITEM_BASE_H
#define WHEEL_ITEM_BASE_H
@@ -10,18 +8,18 @@
#include "AutoActor.h"
struct WheelItemBaseData;
/** @brief The different types of Wheel Items. */
enum WheelItemDataType
{
TYPE_GENERIC,
TYPE_SECTION,
TYPE_SONG,
TYPE_ROULETTE,
TYPE_RANDOM,
TYPE_PORTAL,
TYPE_COURSE,
TYPE_SORT/*,
TYPE_CUSTOM*/
TYPE_GENERIC, /**< A generic item on the Wheel. */
TYPE_SECTION, /**< A general section on the Wheel. */
TYPE_SONG, /**< A Song on the Wheel. */
TYPE_ROULETTE, /**< The roulette section on the Wheel. */
TYPE_RANDOM, /**< The random section on the Wheel. */
TYPE_PORTAL, /**< The portal section on the Wheel. */
TYPE_COURSE, /**< A Course on the Wheel. */
TYPE_SORT, /**< A generic sorting item on the Wheel. */
//TYPE_CUSTOM
};
struct WheelItemBaseData
@@ -33,7 +31,7 @@ struct WheelItemBaseData
RString m_sText;
RageColor m_color; // either text color or section background color
};
/** @brief An item on the wheel. */
class WheelItemBase : public ActorFrame
{
public: