diff --git a/src/Course.h b/src/Course.h index 0cf8656271..b83b627334 100644 --- a/src/Course.h +++ b/src/Course.h @@ -1,5 +1,3 @@ -/* Course - A queue of songs and notes. */ - #ifndef COURSE_H #define COURSE_H @@ -79,7 +77,7 @@ public: void PushSelf( lua_State *L ); }; - +/** @brief A queue of songs and notes. */ class Course { public: diff --git a/src/EditMenu.h b/src/EditMenu.h index 0709670202..6d641cbdec 100644 --- a/src/EditMenu.h +++ b/src/EditMenu.h @@ -1,5 +1,3 @@ -/* EditMenu - UI on Edit Menu screen. Create Steps, delete Steps, or launch Steps in editor. */ - #ifndef EDIT_MENU_H #define EDIT_MENU_H @@ -43,6 +41,10 @@ const RString& EditMenuActionToLocalizedString( EditMenuAction ema ); const int NUM_ARROWS = 2; +/** + * @brief UI on Edit Menu screen. + * + * Create Steps, delete Steps, or launch Steps in editor. */ class EditMenu: public ActorFrame { public: diff --git a/src/GameState.h b/src/GameState.h index 032f75d58f..89de4c05dc 100644 --- a/src/GameState.h +++ b/src/GameState.h @@ -1,5 +1,3 @@ -/** @brief GameState - Holds game data that is not saved between sessions. */ - #ifndef GAMESTATE_H #define GAMESTATE_H @@ -33,6 +31,7 @@ class Style; class TimingData; class Trail; +/** @brief Holds game data that is not saved between sessions. */ class GameState { public: diff --git a/src/InputMapper.h b/src/InputMapper.h index 66aadc2f09..f823f6549a 100644 --- a/src/InputMapper.h +++ b/src/InputMapper.h @@ -1,5 +1,3 @@ -/* InputMapper - Holds user-chosen input preferences and saves it between sessions. */ - #ifndef INPUT_MAPPER_H #define INPUT_MAPPER_H @@ -151,7 +149,7 @@ public: void ClearFromInputMap( const DeviceInput &DeviceI ); bool ClearFromInputMap( const GameInput &GameI, int iSlotIndex ); }; - +/** @brief Holds user-chosen input preferences and saves it between sessions. */ class InputMapper { public: diff --git a/src/LightsManager.h b/src/LightsManager.h index 6fff605686..1e75a683b7 100644 --- a/src/LightsManager.h +++ b/src/LightsManager.h @@ -1,5 +1,3 @@ -/* LightsManager - Control lights. */ - #ifndef LightsManager_H #define LightsManager_H @@ -56,7 +54,7 @@ struct LightsState }; class LightsDriver; - +/** @brief Control lights. */ class LightsManager { public: diff --git a/src/LuaManager.h b/src/LuaManager.h index 9a644bd6f3..ef6bd4454d 100644 --- a/src/LuaManager.h +++ b/src/LuaManager.h @@ -15,9 +15,6 @@ extern "C" #include "lua-5.1/src/lauxlib.h" } -class LuaManager; -extern LuaManager *LUA; - class LuaManager { public: @@ -47,6 +44,8 @@ private: lua_State *m_pLuaMain; }; +extern LuaManager *LUA; + namespace LuaHelpers { diff --git a/src/NetworkSyncManager.h b/src/NetworkSyncManager.h index 18a34455ae..0c92c70d91 100644 --- a/src/NetworkSyncManager.h +++ b/src/NetworkSyncManager.h @@ -1,5 +1,3 @@ -/* NetworkSyncManager - Uses ezsockets for primitive song syncing and score reporting. */ - #ifndef NetworkSyncManager_H #define NetworkSyncManager_H @@ -107,7 +105,7 @@ public: void ClearPacket(); }; - +/** @brief Uses ezsockets for primitive song syncing and score reporting. */ class NetworkSyncManager { public: diff --git a/src/NoteDisplay.h b/src/NoteDisplay.h index 8690ae13a6..0f1d938798 100644 --- a/src/NoteDisplay.h +++ b/src/NoteDisplay.h @@ -1,5 +1,3 @@ -/* NoteDisplay - Draws TapNotes and HoldNotes. */ - #ifndef NOTE_DISPLAY_H #define NOTE_DISPLAY_H @@ -71,7 +69,7 @@ enum ActiveType #define FOREACH_ActiveType( i ) FOREACH_ENUM( ActiveType, i ) const RString &ActiveTypeToString( ActiveType at ); - +/** @brief Draws TapNotes and HoldNotes. */ class NoteDisplay { public: diff --git a/src/ScreenEdit.h b/src/ScreenEdit.h index 1fe452b6d6..f4f38717f7 100644 --- a/src/ScreenEdit.h +++ b/src/ScreenEdit.h @@ -1,5 +1,3 @@ -/* ScreenEdit - Edit, record, playback, and synchronize notes. */ - #ifndef SCREEN_EDIT_H #define SCREEN_EDIT_H @@ -171,7 +169,7 @@ struct MapEditButtonToMenuButton button[e][slot] = GameButton_Invalid; } }; - +/** @brief Edit, record, playback, and synchronize notes. */ class ScreenEdit : public ScreenWithMenuElements { public: diff --git a/src/ScreenOptions.h b/src/ScreenOptions.h index d9d96273d4..a0ddfa948c 100644 --- a/src/ScreenOptions.h +++ b/src/ScreenOptions.h @@ -1,5 +1,3 @@ -/** @brief ScreenOptions - A grid of options; the selected option is drawn with a highlight rectangle. */ - #ifndef SCREENOPTIONS_H #define SCREENOPTIONS_H @@ -30,6 +28,7 @@ InputMode StringToInputMode( const RString& str ); #define FOREACH_OptionsPlayer( 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 { public: diff --git a/src/ScreenSelectMaster.h b/src/ScreenSelectMaster.h index b86679feff..838e6821d0 100644 --- a/src/ScreenSelectMaster.h +++ b/src/ScreenSelectMaster.h @@ -20,6 +20,7 @@ enum MenuDir #define FOREACH_MenuDir( md ) FOREACH_ENUM( MenuDir, md ) const RString& MenuDirToString( MenuDir md ); +/** @brief The master Screen for many children Screens. */ class ScreenSelectMaster : public ScreenSelect { public: diff --git a/src/Song.h b/src/Song.h index 360eb8f129..215e583d64 100644 --- a/src/Song.h +++ b/src/Song.h @@ -1,5 +1,3 @@ -/** @brief Song - Holds all music metadata and steps for one song. */ - #ifndef SONG_H #define SONG_H @@ -57,6 +55,7 @@ struct LyricSegment RageColor m_Color; /** @brief The color of the lyrics. */ }; +/** @brief Holds all music metadata and steps for one song. */ class Song { RString m_sSongDir; diff --git a/src/ThemeManager.h b/src/ThemeManager.h index 7a78b777af..a8c20e7067 100644 --- a/src/ThemeManager.h +++ b/src/ThemeManager.h @@ -1,5 +1,3 @@ -/* ThemeManager - Manages theme paths and metrics. */ - #ifndef THEMEMANAGER_H #define THEMEMANAGER_H @@ -27,7 +25,7 @@ const RString& ElementCategoryToString( ElementCategory ec ); ElementCategory StringToElementCategory( const RString& s ); struct Theme; - +/** @brief Manages theme paths and metrics. */ class ThemeManager { public: diff --git a/src/Tween.h b/src/Tween.h index 304ee6a75b..a9e6cbca42 100644 --- a/src/Tween.h +++ b/src/Tween.h @@ -1,5 +1,3 @@ -/** @brief ITween - Interface for simple interpolation. */ - #ifndef TWEEN_H #define TWEEN_H