Move some top comments to above the class.
The original attempt was not working for doxygen purposes.
This commit is contained in:
+1
-3
@@ -1,5 +1,3 @@
|
|||||||
/* Course - A queue of songs and notes. */
|
|
||||||
|
|
||||||
#ifndef COURSE_H
|
#ifndef COURSE_H
|
||||||
#define COURSE_H
|
#define COURSE_H
|
||||||
|
|
||||||
@@ -79,7 +77,7 @@ public:
|
|||||||
void PushSelf( lua_State *L );
|
void PushSelf( lua_State *L );
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/** @brief A queue of songs and notes. */
|
||||||
class Course
|
class Course
|
||||||
{
|
{
|
||||||
public:
|
public:
|
||||||
|
|||||||
+4
-2
@@ -1,5 +1,3 @@
|
|||||||
/* EditMenu - UI on Edit Menu screen. Create Steps, delete Steps, or launch Steps in editor. */
|
|
||||||
|
|
||||||
#ifndef EDIT_MENU_H
|
#ifndef EDIT_MENU_H
|
||||||
#define EDIT_MENU_H
|
#define EDIT_MENU_H
|
||||||
|
|
||||||
@@ -43,6 +41,10 @@ const RString& EditMenuActionToLocalizedString( EditMenuAction ema );
|
|||||||
|
|
||||||
const int NUM_ARROWS = 2;
|
const int NUM_ARROWS = 2;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief UI on Edit Menu screen.
|
||||||
|
*
|
||||||
|
* Create Steps, delete Steps, or launch Steps in editor. */
|
||||||
class EditMenu: public ActorFrame
|
class EditMenu: public ActorFrame
|
||||||
{
|
{
|
||||||
public:
|
public:
|
||||||
|
|||||||
+1
-2
@@ -1,5 +1,3 @@
|
|||||||
/** @brief GameState - Holds game data that is not saved between sessions. */
|
|
||||||
|
|
||||||
#ifndef GAMESTATE_H
|
#ifndef GAMESTATE_H
|
||||||
#define GAMESTATE_H
|
#define GAMESTATE_H
|
||||||
|
|
||||||
@@ -33,6 +31,7 @@ class Style;
|
|||||||
class TimingData;
|
class TimingData;
|
||||||
class Trail;
|
class Trail;
|
||||||
|
|
||||||
|
/** @brief Holds game data that is not saved between sessions. */
|
||||||
class GameState
|
class GameState
|
||||||
{
|
{
|
||||||
public:
|
public:
|
||||||
|
|||||||
+1
-3
@@ -1,5 +1,3 @@
|
|||||||
/* InputMapper - Holds user-chosen input preferences and saves it between sessions. */
|
|
||||||
|
|
||||||
#ifndef INPUT_MAPPER_H
|
#ifndef INPUT_MAPPER_H
|
||||||
#define INPUT_MAPPER_H
|
#define INPUT_MAPPER_H
|
||||||
|
|
||||||
@@ -151,7 +149,7 @@ public:
|
|||||||
void ClearFromInputMap( const DeviceInput &DeviceI );
|
void ClearFromInputMap( const DeviceInput &DeviceI );
|
||||||
bool ClearFromInputMap( const GameInput &GameI, int iSlotIndex );
|
bool ClearFromInputMap( const GameInput &GameI, int iSlotIndex );
|
||||||
};
|
};
|
||||||
|
/** @brief Holds user-chosen input preferences and saves it between sessions. */
|
||||||
class InputMapper
|
class InputMapper
|
||||||
{
|
{
|
||||||
public:
|
public:
|
||||||
|
|||||||
+1
-3
@@ -1,5 +1,3 @@
|
|||||||
/* LightsManager - Control lights. */
|
|
||||||
|
|
||||||
#ifndef LightsManager_H
|
#ifndef LightsManager_H
|
||||||
#define LightsManager_H
|
#define LightsManager_H
|
||||||
|
|
||||||
@@ -56,7 +54,7 @@ struct LightsState
|
|||||||
};
|
};
|
||||||
|
|
||||||
class LightsDriver;
|
class LightsDriver;
|
||||||
|
/** @brief Control lights. */
|
||||||
class LightsManager
|
class LightsManager
|
||||||
{
|
{
|
||||||
public:
|
public:
|
||||||
|
|||||||
+2
-3
@@ -15,9 +15,6 @@ extern "C"
|
|||||||
#include "lua-5.1/src/lauxlib.h"
|
#include "lua-5.1/src/lauxlib.h"
|
||||||
}
|
}
|
||||||
|
|
||||||
class LuaManager;
|
|
||||||
extern LuaManager *LUA;
|
|
||||||
|
|
||||||
class LuaManager
|
class LuaManager
|
||||||
{
|
{
|
||||||
public:
|
public:
|
||||||
@@ -47,6 +44,8 @@ private:
|
|||||||
lua_State *m_pLuaMain;
|
lua_State *m_pLuaMain;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
extern LuaManager *LUA;
|
||||||
|
|
||||||
|
|
||||||
namespace LuaHelpers
|
namespace LuaHelpers
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -1,5 +1,3 @@
|
|||||||
/* NetworkSyncManager - Uses ezsockets for primitive song syncing and score reporting. */
|
|
||||||
|
|
||||||
#ifndef NetworkSyncManager_H
|
#ifndef NetworkSyncManager_H
|
||||||
#define NetworkSyncManager_H
|
#define NetworkSyncManager_H
|
||||||
|
|
||||||
@@ -107,7 +105,7 @@ public:
|
|||||||
|
|
||||||
void ClearPacket();
|
void ClearPacket();
|
||||||
};
|
};
|
||||||
|
/** @brief Uses ezsockets for primitive song syncing and score reporting. */
|
||||||
class NetworkSyncManager
|
class NetworkSyncManager
|
||||||
{
|
{
|
||||||
public:
|
public:
|
||||||
|
|||||||
+1
-3
@@ -1,5 +1,3 @@
|
|||||||
/* NoteDisplay - Draws TapNotes and HoldNotes. */
|
|
||||||
|
|
||||||
#ifndef NOTE_DISPLAY_H
|
#ifndef NOTE_DISPLAY_H
|
||||||
#define NOTE_DISPLAY_H
|
#define NOTE_DISPLAY_H
|
||||||
|
|
||||||
@@ -71,7 +69,7 @@ enum ActiveType
|
|||||||
#define FOREACH_ActiveType( i ) FOREACH_ENUM( ActiveType, i )
|
#define FOREACH_ActiveType( i ) FOREACH_ENUM( ActiveType, i )
|
||||||
const RString &ActiveTypeToString( ActiveType at );
|
const RString &ActiveTypeToString( ActiveType at );
|
||||||
|
|
||||||
|
/** @brief Draws TapNotes and HoldNotes. */
|
||||||
class NoteDisplay
|
class NoteDisplay
|
||||||
{
|
{
|
||||||
public:
|
public:
|
||||||
|
|||||||
+1
-3
@@ -1,5 +1,3 @@
|
|||||||
/* ScreenEdit - Edit, record, playback, and synchronize notes. */
|
|
||||||
|
|
||||||
#ifndef SCREEN_EDIT_H
|
#ifndef SCREEN_EDIT_H
|
||||||
#define SCREEN_EDIT_H
|
#define SCREEN_EDIT_H
|
||||||
|
|
||||||
@@ -171,7 +169,7 @@ struct MapEditButtonToMenuButton
|
|||||||
button[e][slot] = GameButton_Invalid;
|
button[e][slot] = GameButton_Invalid;
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
/** @brief Edit, record, playback, and synchronize notes. */
|
||||||
class ScreenEdit : public ScreenWithMenuElements
|
class ScreenEdit : public ScreenWithMenuElements
|
||||||
{
|
{
|
||||||
public:
|
public:
|
||||||
|
|||||||
+1
-2
@@ -1,5 +1,3 @@
|
|||||||
/** @brief ScreenOptions - A grid of options; the selected option is drawn with a highlight rectangle. */
|
|
||||||
|
|
||||||
#ifndef SCREENOPTIONS_H
|
#ifndef SCREENOPTIONS_H
|
||||||
#define SCREENOPTIONS_H
|
#define SCREENOPTIONS_H
|
||||||
|
|
||||||
@@ -30,6 +28,7 @@ InputMode StringToInputMode( const RString& str );
|
|||||||
#define FOREACH_OptionsPlayer( pn ) \
|
#define FOREACH_OptionsPlayer( pn ) \
|
||||||
for( PlayerNumber pn=GetNextHumanPlayer((PlayerNumber)-1); pn!=PLAYER_INVALID && (m_InputMode==INPUTMODE_INDIVIDUAL || pn==0); pn=GetNextHumanPlayer(pn) )
|
for( PlayerNumber pn=GetNextHumanPlayer((PlayerNumber)-1); pn!=PLAYER_INVALID && (m_InputMode==INPUTMODE_INDIVIDUAL || pn==0); pn=GetNextHumanPlayer(pn) )
|
||||||
|
|
||||||
|
/** @brief A grid of options; the selected option is drawn with a highlight rectangle. */
|
||||||
class ScreenOptions : public ScreenWithMenuElements
|
class ScreenOptions : public ScreenWithMenuElements
|
||||||
{
|
{
|
||||||
public:
|
public:
|
||||||
|
|||||||
@@ -20,6 +20,7 @@ enum MenuDir
|
|||||||
#define FOREACH_MenuDir( md ) FOREACH_ENUM( MenuDir, md )
|
#define FOREACH_MenuDir( md ) FOREACH_ENUM( MenuDir, md )
|
||||||
const RString& MenuDirToString( MenuDir md );
|
const RString& MenuDirToString( MenuDir md );
|
||||||
|
|
||||||
|
/** @brief The master Screen for many children Screens. */
|
||||||
class ScreenSelectMaster : public ScreenSelect
|
class ScreenSelectMaster : public ScreenSelect
|
||||||
{
|
{
|
||||||
public:
|
public:
|
||||||
|
|||||||
+1
-2
@@ -1,5 +1,3 @@
|
|||||||
/** @brief Song - Holds all music metadata and steps for one song. */
|
|
||||||
|
|
||||||
#ifndef SONG_H
|
#ifndef SONG_H
|
||||||
#define SONG_H
|
#define SONG_H
|
||||||
|
|
||||||
@@ -57,6 +55,7 @@ struct LyricSegment
|
|||||||
RageColor m_Color; /** @brief The color of the lyrics. */
|
RageColor m_Color; /** @brief The color of the lyrics. */
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/** @brief Holds all music metadata and steps for one song. */
|
||||||
class Song
|
class Song
|
||||||
{
|
{
|
||||||
RString m_sSongDir;
|
RString m_sSongDir;
|
||||||
|
|||||||
+1
-3
@@ -1,5 +1,3 @@
|
|||||||
/* ThemeManager - Manages theme paths and metrics. */
|
|
||||||
|
|
||||||
#ifndef THEMEMANAGER_H
|
#ifndef THEMEMANAGER_H
|
||||||
#define THEMEMANAGER_H
|
#define THEMEMANAGER_H
|
||||||
|
|
||||||
@@ -27,7 +25,7 @@ const RString& ElementCategoryToString( ElementCategory ec );
|
|||||||
ElementCategory StringToElementCategory( const RString& s );
|
ElementCategory StringToElementCategory( const RString& s );
|
||||||
|
|
||||||
struct Theme;
|
struct Theme;
|
||||||
|
/** @brief Manages theme paths and metrics. */
|
||||||
class ThemeManager
|
class ThemeManager
|
||||||
{
|
{
|
||||||
public:
|
public:
|
||||||
|
|||||||
@@ -1,5 +1,3 @@
|
|||||||
/** @brief ITween - Interface for simple interpolation. */
|
|
||||||
|
|
||||||
#ifndef TWEEN_H
|
#ifndef TWEEN_H
|
||||||
#define TWEEN_H
|
#define TWEEN_H
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user