From 8f3791b99a4c99443a38add4b2c878064629e8a8 Mon Sep 17 00:00:00 2001 From: AJ Kelly Date: Fri, 10 Sep 2010 16:37:04 -0500 Subject: [PATCH] massive header file comment updating (top line only; some didn't have it before) --- src/ActiveAttackList.h | 1 + src/ActorMultiTexture.h | 2 +- src/AdjustSync.h | 24 +++++++++++------------- src/ArrowEffects.h | 8 +++----- src/AttackDisplay.h | 1 + src/AutoKeysounds.h | 2 +- src/Banner.h | 2 +- src/BeginnerHelper.h | 7 ++++--- src/CharacterManager.h | 2 +- src/ComboGraph.h | 1 + src/CommonMetrics.h | 2 +- src/DifficultyList.h | 5 +++-- src/EditMenu.h | 4 +++- src/FontCharAliases.h | 1 + src/FontCharmaps.h | 1 + src/Foreground.h | 1 + src/Game.h | 18 +++++++++--------- src/GraphDisplay.h | 1 + src/GrooveRadar.h | 2 +- src/GroupList.h | 1 + src/LifeMeterBar.h | 2 ++ src/LifeMeterTime.h | 2 +- src/LyricDisplay.h | 1 + src/MemoryCardDisplay.h | 2 ++ src/MeterDisplay.h | 7 ++++++- src/MusicList.h | 2 +- src/MusicWheelItem.h | 2 +- src/NotesLoaderPMS.h | 2 +- src/PitchDetectionTest.h | 2 +- src/PitchDetectionTestUtil.h | 2 +- src/PlayerNumber.h | 2 -- src/Profile.h | 3 ++- src/RageSurface_Load_GIF.h | 2 ++ src/RageSurface_Load_JPEG.h | 2 ++ src/RageSurface_Load_PNG.h | 2 ++ src/RageSurface_Load_XPM.h | 2 ++ src/RageSurface_Save_BMP.h | 2 ++ src/RageSurface_Save_JPEG.h | 2 ++ src/RageTextureManager.h | 8 ++++---- src/RageUtil.h | 2 +- src/RoomInfoDisplay.h | 2 ++ src/ScreenAttract.h | 2 +- 42 files changed, 86 insertions(+), 55 deletions(-) diff --git a/src/ActiveAttackList.h b/src/ActiveAttackList.h index b05fd80329..169f1af1ff 100644 --- a/src/ActiveAttackList.h +++ b/src/ActiveAttackList.h @@ -1,3 +1,4 @@ +/* ActiveAttackList - Shows currently active player modifiers during gameplay. */ #ifndef ACTIVE_ATTACK_LIST_H #define ACTIVE_ATTACK_LIST_H diff --git a/src/ActorMultiTexture.h b/src/ActorMultiTexture.h index 314fe59095..f0f0f70919 100644 --- a/src/ActorMultiTexture.h +++ b/src/ActorMultiTexture.h @@ -1,4 +1,4 @@ -/* ActorMultiTexture - A bitmap Actor that animates and moves around. */ +/* ActorMultiTexture - A texture created from multiple textures. */ #ifndef ACTOR_MULTI_TEXTURE_H #define ACTOR_MULTI_TEXTURE_H diff --git a/src/AdjustSync.h b/src/AdjustSync.h index fbd3cc2489..9131992b94 100644 --- a/src/AdjustSync.h +++ b/src/AdjustSync.h @@ -1,12 +1,11 @@ +/* AdjustSync - Allows for adjusting the sync of a song. */ #ifndef AdjustSync_H #define AdjustSync_H -/* - * This class defines two ways of adjusting the sync of a song. - * The first adjusts only the offset, "on the fly". It can adjust - * either the song itself or the machine. The other style adjusts - * both the BPM and the offset of the song, but it needs more data. - */ +/* This class defines two ways of adjusting the sync of a song. + * The first adjusts only the offset, "on the fly". It can adjust either the + * song itself or the machine. The other style adjusts both the BPM and the + * offset of the song, but it needs more data. */ class TimingData; @@ -15,16 +14,15 @@ class AdjustSync public: static TimingData *s_pTimingDataOriginal; static float s_fGlobalOffsetSecondsOriginal; - /* - * We only want to call the Reset methods before a song, not immediately after a song. - * If we reset it at the end of a song, we have to carefully check the logic to make - * sure we never reset it before the user gets a chance to save or revert the change. - * Resetting at the start of the song is sufficient. - */ + /* We only want to call the Reset methods before a song, not immediately after + * a song. If we reset it at the end of a song, we have to carefully check + * the logic to make sure we never reset it before the user gets a chance to + * save or revert the change. Resetting at the start of the song is + * sufficient. */ static void ResetOriginalSyncData(); static void ResetAutosync(); static bool IsSyncDataChanged(); - + static void SaveSyncChanges(); static void RevertSyncChanges(); static void HandleAutosync( float fNoteOffBySeconds, float fStepTime ); diff --git a/src/ArrowEffects.h b/src/ArrowEffects.h index d27eebd831..9f6c7cc655 100644 --- a/src/ArrowEffects.h +++ b/src/ArrowEffects.h @@ -10,9 +10,9 @@ class ArrowEffects public: static void Update(); - // fYOffset is a vertical position in pixels relative to the center. - // (positive if has not yet been stepped on, negative if has already passed). - // The ArrowEffect and ScrollSpeed is applied in this stage. + // fYOffset is a vertical position in pixels relative to the center + // (positive if has not yet been stepped on, negative if has already passed). + // The ArrowEffect and ScrollSpeed is applied in this stage. static float GetYOffset( const PlayerState* pPlayerState, int iCol, float fNoteBeat, float &fPeakYOffsetOut, bool &bIsPastPeakYOffset, bool bAbsolute=false ); static float GetYOffset( const PlayerState* pPlayerState, int iCol, float fNoteBeat, bool bAbsolute=false ) { @@ -54,12 +54,10 @@ public: // AppearanceType. static float GetAlpha( const PlayerState* pPlayerState, int iCol, float fYPos, float fPercentFadeToFail, float fYReverseOffsetPixels, float fDrawDistanceBeforeTargetsPixels, float fFadeInPercentOfDrawFar ); - // fAlpha is the transparency of the arrow. It depends on fYPos and the // AppearanceType. static float GetGlow( const PlayerState* pPlayerState, int iCol, float fYPos, float fPercentFadeToFail, float fYReverseOffsetPixels, float fDrawDistanceBeforeTargetsPixels, float fFadeInPercentOfDrawFar ); - // Depends on fYOffset. static float GetBrightness( const PlayerState* pPlayerState, float fNoteBeat ); diff --git a/src/AttackDisplay.h b/src/AttackDisplay.h index f869a41434..663e36195f 100644 --- a/src/AttackDisplay.h +++ b/src/AttackDisplay.h @@ -1,3 +1,4 @@ +/* AttackDisplay - A graphical display for attacks. */ #ifndef AttackDisplay_H #define AttackDisplay_H diff --git a/src/AutoKeysounds.h b/src/AutoKeysounds.h index 560449c072..ed06d136a8 100644 --- a/src/AutoKeysounds.h +++ b/src/AutoKeysounds.h @@ -1,4 +1,4 @@ -/* AutoKeysounds - handle playback of auto keysounds notes. */ +/* AutoKeysounds - handle playback of auto keysound notes. */ #ifndef AUTO_KEYSOUNDS_H #define AUTO_KEYSOUNDS_H diff --git a/src/Banner.h b/src/Banner.h index 1f99d510aa..7fe790559c 100644 --- a/src/Banner.h +++ b/src/Banner.h @@ -1,4 +1,4 @@ -/* Banner - The song's banner displayed in SelectSong. */ +/* Banner - The song/course's banner displayed in SelectMusic/Course. */ #ifndef BANNER_H #define BANNER_H diff --git a/src/BeginnerHelper.h b/src/BeginnerHelper.h index 12d55dca3a..18edd462f0 100644 --- a/src/BeginnerHelper.h +++ b/src/BeginnerHelper.h @@ -1,3 +1,4 @@ +/* BeginnerHelper - A dancing character that follows the steps of the song. */ #ifndef BEGINNER_HELPER_H #define BEGINNER_HELPER_H @@ -13,13 +14,13 @@ class BeginnerHelper : public ActorFrame public: BeginnerHelper(); ~BeginnerHelper(); - + bool Initialize( int iDancePadType ); bool IsInitialized() { return m_bInitialized; } static bool CanUse(); void AddPlayer( PlayerNumber pn, const NoteData &nd ); void ShowStepCircle( PlayerNumber pn, int CSTEP ); - bool m_bShowBackground; + bool m_bShowBackground; void Update( float fDeltaTime ); virtual void DrawPrimitives(); @@ -37,7 +38,7 @@ protected: int m_iLastRowChecked; int m_iLastRowFlashed; - bool m_bInitialized; + bool m_bInitialized; }; #endif diff --git a/src/CharacterManager.h b/src/CharacterManager.h index e624fabb87..f6d383201c 100644 --- a/src/CharacterManager.h +++ b/src/CharacterManager.h @@ -1,4 +1,4 @@ -/* CharacterManager - Manage characters... */ +/* CharacterManager - Manage characters. */ #ifndef CHARACTER_MANAGER_H #define CHARACTER_MANAGER_H diff --git a/src/ComboGraph.h b/src/ComboGraph.h index fe480a9bcf..2d2f9b01b4 100644 --- a/src/ComboGraph.h +++ b/src/ComboGraph.h @@ -1,3 +1,4 @@ +/* ComboGraph - A bar displaying the player's combo on Evaluation. */ #ifndef COMBO_GRAPH_H #define COMBO_GRAPH_H diff --git a/src/CommonMetrics.h b/src/CommonMetrics.h index 70ef892751..378257ab75 100644 --- a/src/CommonMetrics.h +++ b/src/CommonMetrics.h @@ -1,4 +1,4 @@ -/* Definitions of metrics that are in the "Common" group */ +/* CommonMetrics - Definitions of metrics that are in the "Common" group */ #ifndef COMMON_METRICS_H #define COMMON_METRICS_H diff --git a/src/DifficultyList.h b/src/DifficultyList.h index fc2daf3958..d6ba5084a1 100644 --- a/src/DifficultyList.h +++ b/src/DifficultyList.h @@ -1,3 +1,4 @@ +/* StepsDisplayList - Shows all available difficulties for a Song/Course. */ #ifndef DIFFICULTY_LIST_H #define DIFFICULTY_LIST_H @@ -60,13 +61,13 @@ private: m_fY = 0; m_bHidden = false; } - + const Steps *m_Steps; Difficulty m_dc; float m_fY; bool m_bHidden; // currently off screen }; - + vector m_Rows; }; diff --git a/src/EditMenu.h b/src/EditMenu.h index 9ba37f4cbe..b816250a9e 100644 --- a/src/EditMenu.h +++ b/src/EditMenu.h @@ -1,4 +1,4 @@ -/* EditMenu - UI on Edit Menu screen. Create Steps, delete Steps, or launch Steps in editor. */ +/* EditMenu - UI on Edit Menu screen. Create Steps, delete Steps, or launch Steps in editor. */ #ifndef EDIT_MENU_H #define EDIT_MENU_H @@ -122,10 +122,12 @@ private: ThemeMetric1D ARROWS_X; ThemeMetric ARROWS_ENABLED_COMMAND; ThemeMetric ARROWS_DISABLED_COMMAND; + // todo: remove these next 4 metrics in favor of commands -aj ThemeMetric SONG_BANNER_WIDTH; ThemeMetric SONG_BANNER_HEIGHT; ThemeMetric GROUP_BANNER_WIDTH; ThemeMetric GROUP_BANNER_HEIGHT; + // ThemeMetric ROW_LABELS_X; ThemeMetric ROW_LABEL_ON_COMMAND; ThemeMetric1D ROW_VALUE_X; diff --git a/src/FontCharAliases.h b/src/FontCharAliases.h index df29ae24db..299622b987 100644 --- a/src/FontCharAliases.h +++ b/src/FontCharAliases.h @@ -1,3 +1,4 @@ +/* FontCharAliases - Provides support for nonstandard characters in text. */ #ifndef FONT_CHAR_ALIASES #define FONT_CHAR_ALIASES diff --git a/src/FontCharmaps.h b/src/FontCharmaps.h index 9e36ce718c..da8cdbee85 100644 --- a/src/FontCharmaps.h +++ b/src/FontCharmaps.h @@ -1,3 +1,4 @@ +/* FontCharmaps - Defines common frame to character mappings for Fonts. */ #ifndef FONT_CHARMAPS_H #define FONT_CHARMAPS_H diff --git a/src/Foreground.h b/src/Foreground.h index 8ae9168c40..40e5ec1450 100644 --- a/src/Foreground.h +++ b/src/Foreground.h @@ -1,3 +1,4 @@ +/* Foreground - Foreground in front of notes while playing. */ #ifndef FOREGROUND_H #define FOREGROUND_H diff --git a/src/Game.h b/src/Game.h index 56ecc2dd45..18279a2ecb 100644 --- a/src/Game.h +++ b/src/Game.h @@ -11,16 +11,16 @@ class Style; // PrimaryMenuButton and SecondaryMenuButton are used to support using // DeviceInputs that only navigate the menus. -// + // A button being a primary menu button means that this GameButton will generate // a the corresponding MenuInput IF AND ONLY IF the GameButton corresponding to // the pimary input is not mapped. -// + // Example 1: A user is using an arcade machine as their controller. Most // machines have MenuLeft, MenuStart, and MenuRight buttons on the cabinet, so // they should be used to navigate menus. The user will map these DeviceInputs // to the GameButtons "MenuLeft (optional)", "MenuStart", and "MenuRight (optional)". -// + // Example 2: A user is using PlayStation dance pads to play. These controllers // don't have dedicated DeviceInputs for MenuLeft and MenuRight. The user maps // Up, Down, Left, and Right as normal. Since the Left and Right GameButtons @@ -41,16 +41,16 @@ public: { GameButtonType m_gbt; }; - /* Data for each Game-specific GameButton. This starts at GAME_BUTTON_NEXT. */ + // Data for each Game-specific GameButton. This starts at GAME_BUTTON_NEXT. PerButtonInfo m_PerButtonInfo[NUM_GameButton]; const PerButtonInfo *GetPerButtonInfo( GameButton gb ) const; TapNoteScore MapTapNoteScore( TapNoteScore tns ) const; - TapNoteScore m_mapW1To; - TapNoteScore m_mapW2To; - TapNoteScore m_mapW3To; - TapNoteScore m_mapW4To; - TapNoteScore m_mapW5To; + TapNoteScore m_mapW1To; + TapNoteScore m_mapW2To; + TapNoteScore m_mapW3To; + TapNoteScore m_mapW4To; + TapNoteScore m_mapW5To; // Lua void PushSelf( lua_State *L ); diff --git a/src/GraphDisplay.h b/src/GraphDisplay.h index 22572ff166..6931ac5647 100644 --- a/src/GraphDisplay.h +++ b/src/GraphDisplay.h @@ -1,3 +1,4 @@ +/* GraphDisplay - A graph of the player's life over the course of Gameplay, used on Evaluation. */ #ifndef GRAPH_DISPLAY_H #define GRAPH_DISPLAY_H diff --git a/src/GrooveRadar.h b/src/GrooveRadar.h index 0c4125fb24..79d1f1df28 100644 --- a/src/GrooveRadar.h +++ b/src/GrooveRadar.h @@ -1,4 +1,4 @@ -/* GrooveRadar - The song's GrooveRadar displayed in SelectSong. */ +/* GrooveRadar - The song's GrooveRadar displayed in SelectMusic. */ #ifndef GROOVE_RADAR_H #define GROOVE_RADAR_H diff --git a/src/GroupList.h b/src/GroupList.h index 3fc3c72788..55121dc920 100644 --- a/src/GroupList.h +++ b/src/GroupList.h @@ -1,3 +1,4 @@ +/* GroupList - Displays a list of groups for SelectGroup. (An old holdover.) */ #ifndef GROUP_LIST_H #define GROUP_LIST_H diff --git a/src/LifeMeterBar.h b/src/LifeMeterBar.h index 29a7c435e7..f708185b66 100644 --- a/src/LifeMeterBar.h +++ b/src/LifeMeterBar.h @@ -1,3 +1,5 @@ +/* LifeMeterBar - The player's life represented as a bar. */ + #ifndef LIFEMETERBAR_H #define LIFEMETERBAR_H diff --git a/src/LifeMeterTime.h b/src/LifeMeterTime.h index 8ad522a0df..e318d480bf 100644 --- a/src/LifeMeterTime.h +++ b/src/LifeMeterTime.h @@ -1,4 +1,4 @@ -/* LifeMeterTime - Battery life meter used in Oni. */ +/* LifeMeterTime - Battery life meter used in Survival. */ #ifndef LifeMeterTime_H #define LifeMeterTime_H diff --git a/src/LyricDisplay.h b/src/LyricDisplay.h index 83676225e6..f4f1f3c359 100644 --- a/src/LyricDisplay.h +++ b/src/LyricDisplay.h @@ -1,4 +1,5 @@ /* LyricDisplay - Displays lyrics along with the song on Gameplay. */ + #ifndef LYRIC_DISPLAY_H #define LYRIC_DISPLAY_H diff --git a/src/MemoryCardDisplay.h b/src/MemoryCardDisplay.h index 762412d43b..3021aeb765 100644 --- a/src/MemoryCardDisplay.h +++ b/src/MemoryCardDisplay.h @@ -1,3 +1,5 @@ +/* MemoryCardDisplay - A graphic displaying the state of memory cards. */ + #ifndef MEMORY_CARD_DISPLAY_H #define MEMORY_CARD_DISPLAY_H diff --git a/src/MeterDisplay.h b/src/MeterDisplay.h index 6a1f580c8d..2d757e0be6 100644 --- a/src/MeterDisplay.h +++ b/src/MeterDisplay.h @@ -1,4 +1,5 @@ -/* MeterDisplay - */ +/* MeterDisplay - Display position in a song. */ + #ifndef METER_DISPLAY_H #define METER_DISPLAY_H @@ -15,6 +16,10 @@ public: virtual MeterDisplay *Copy() const; void SetPercent( float fPercent ); + void SetStreamWidth( float fStreamWidth ); + + // Lua + void PushSelf( lua_State *L ); private: float m_fStreamWidth; diff --git a/src/MusicList.h b/src/MusicList.h index db36e916a1..bb505d74c7 100644 --- a/src/MusicList.h +++ b/src/MusicList.h @@ -1,4 +1,4 @@ -/* MusicList - now an artifact from ScreenSelectGroup. */ +/* MusicList - Displays all the songs in a given group. (An artifact from SelectGroup.) */ #ifndef MUSIC_LIST_H #define MUSIC_LIST_H diff --git a/src/MusicWheelItem.h b/src/MusicWheelItem.h index eee58b2e88..246de3e0d6 100644 --- a/src/MusicWheelItem.h +++ b/src/MusicWheelItem.h @@ -1,4 +1,4 @@ -/* MusicWheelItem - An item on the music wheel. */ +/* MusicWheelItem - An item on the MusicWheel. */ #ifndef MUSIC_WHEEL_ITEM_H #define MUSIC_WHEEL_ITEM_H diff --git a/src/NotesLoaderPMS.h b/src/NotesLoaderPMS.h index 99a632c701..3baa700fb9 100644 --- a/src/NotesLoaderPMS.h +++ b/src/NotesLoaderPMS.h @@ -1,4 +1,4 @@ -/* BMSLoader - reads a Song from a set of .BMS files. */ +/* PMSLoader - reads a Song from a set of .PMS files. */ #ifndef NOTES_LOADER_PMS_H #define NOTES_LOADER_PMS_H diff --git a/src/PitchDetectionTest.h b/src/PitchDetectionTest.h index 54836f669b..e883a43f4f 100644 --- a/src/PitchDetectionTest.h +++ b/src/PitchDetectionTest.h @@ -1,4 +1,4 @@ -/* Microphone - */ +/* Microphone - Holdover from incomplete karaoke mode. */ #ifndef Microphone_H #define Microphone_H diff --git a/src/PitchDetectionTestUtil.h b/src/PitchDetectionTestUtil.h index 7c9817e38f..6e25ce2725 100644 --- a/src/PitchDetectionTestUtil.h +++ b/src/PitchDetectionTestUtil.h @@ -1,4 +1,4 @@ -/* PitchDetectionTestUtil - */ +/* PitchDetectionTestUtil - Holdover from incomplete karaoke mode. */ #ifndef PitchDetectionTestUtil_H #define PitchDetectionTestUtil_H diff --git a/src/PlayerNumber.h b/src/PlayerNumber.h index 9c8104c5d6..11bd42a8b1 100644 --- a/src/PlayerNumber.h +++ b/src/PlayerNumber.h @@ -6,9 +6,7 @@ #include "EnumHelper.h" -// // Player number stuff -// enum PlayerNumber { PLAYER_1 = 0, diff --git a/src/Profile.h b/src/Profile.h index 8f85d3ac1b..aa998d3825 100644 --- a/src/Profile.h +++ b/src/Profile.h @@ -1,4 +1,4 @@ -/* Profile - Player data that persists between sessions. Can be stored on a local disk or on a memory card. */ +/* Profile - Player data that persists between sessions. Can be stored on a local disk or on a memory card. */ #ifndef Profile_H #define Profile_H @@ -96,6 +96,7 @@ public: RString m_sCharacterID; RString m_sLastUsedHighScoreName; // this doesn't really belong in "editable", but we need it in the smaller editable file so that it can be ready quickly. int m_iWeightPounds; // 0 == not set + //RString m_sProfileImageName; // todo: add a default image -aj // General data static RString MakeGuid(); diff --git a/src/RageSurface_Load_GIF.h b/src/RageSurface_Load_GIF.h index a21301673c..69ddb3efcc 100644 --- a/src/RageSurface_Load_GIF.h +++ b/src/RageSurface_Load_GIF.h @@ -1,3 +1,5 @@ +/* RageSurface_Load_GIF - (non-animated) GIF file loader */ + #ifndef RAGE_SURFACE_LOAD_GIF_H #define RAGE_SURFACE_LOAD_GIF_H diff --git a/src/RageSurface_Load_JPEG.h b/src/RageSurface_Load_JPEG.h index 4eea222042..a452779b90 100644 --- a/src/RageSurface_Load_JPEG.h +++ b/src/RageSurface_Load_JPEG.h @@ -1,3 +1,5 @@ +/* RageSurface_Load_JPEG - JPEG file loader */ + #ifndef RAGE_SURFACE_LOAD_JPEG_H #define RAGE_SURFACE_LOAD_JPEG_H diff --git a/src/RageSurface_Load_PNG.h b/src/RageSurface_Load_PNG.h index 40592ed86b..c2a0765273 100644 --- a/src/RageSurface_Load_PNG.h +++ b/src/RageSurface_Load_PNG.h @@ -1,3 +1,5 @@ +/* RageSurface_Load_PNG - PNG file loader */ + #ifndef RAGE_SURFACE_LOAD_PNG_H #define RAGE_SURFACE_LOAD_PNG_H diff --git a/src/RageSurface_Load_XPM.h b/src/RageSurface_Load_XPM.h index 203a641ea3..5df75ba977 100644 --- a/src/RageSurface_Load_XPM.h +++ b/src/RageSurface_Load_XPM.h @@ -1,3 +1,5 @@ +/* RageSurface_Load_XPM - XPM file loader */ + #ifndef RAGE_SURFACE_LOAD_XPM_H #define RAGE_SURFACE_LOAD_XPM_H diff --git a/src/RageSurface_Save_BMP.h b/src/RageSurface_Save_BMP.h index ba300d22d1..eb928a1eb8 100644 --- a/src/RageSurface_Save_BMP.h +++ b/src/RageSurface_Save_BMP.h @@ -1,3 +1,5 @@ +/* RageSurface_Save_BMP - Save a RageSurface to a BMP. */ + #ifndef RAGE_SURFACE_SAVE_BMP_H #define RAGE_SURFACE_SAVE_BMP_H diff --git a/src/RageSurface_Save_JPEG.h b/src/RageSurface_Save_JPEG.h index 17b6b20905..ebde4ab2f8 100644 --- a/src/RageSurface_Save_JPEG.h +++ b/src/RageSurface_Save_JPEG.h @@ -1,3 +1,5 @@ +/* RageSurface_Save_JPEG - Save a RageSurface to a JPEG. */ + #ifndef RAGE_SURFACE_SAVE_JPEG_H #define RAGE_SURFACE_SAVE_JPEG_H diff --git a/src/RageTextureManager.h b/src/RageTextureManager.h index c618284dcb..06c0f525ec 100644 --- a/src/RageTextureManager.h +++ b/src/RageTextureManager.h @@ -1,4 +1,4 @@ -/* RageTextureManager - Interface for loading textures. */ +/* RageTextureManager - Interface for loading textures. */ #ifndef RAGE_TEXTURE_MANAGER_H #define RAGE_TEXTURE_MANAGER_H @@ -74,12 +74,12 @@ public: // call this between Screens void DeleteCachedTextures() { GarbageCollect( screen_changed ); } - + // call this on switch theme void DoDelayedDelete() { GarbageCollect( delayed_delete ); } - + void InvalidateTextures(); - + void AdjustTextureID( RageTextureID &ID ) const; void DiagnosticOutput() const; diff --git a/src/RageUtil.h b/src/RageUtil.h index a2fe6f4773..f5eb111326 100644 --- a/src/RageUtil.h +++ b/src/RageUtil.h @@ -1,4 +1,4 @@ -/* RageUtil - Miscellaneous helper macros and functions. */ +/* RageUtil - Miscellaneous helper macros and functions. */ #ifndef RAGE_UTIL_H #define RAGE_UTIL_H diff --git a/src/RoomInfoDisplay.h b/src/RoomInfoDisplay.h index 1891f2c827..e0a676f38d 100644 --- a/src/RoomInfoDisplay.h +++ b/src/RoomInfoDisplay.h @@ -1,3 +1,5 @@ +/* RoomInfoDisplay: Shows information about an online game room. */ + #ifndef ROOM_INFO_DISPLAY_H #define ROOM_INFO_DISPLAY_H diff --git a/src/ScreenAttract.h b/src/ScreenAttract.h index bb9dc629ab..19ead8bd66 100644 --- a/src/ScreenAttract.h +++ b/src/ScreenAttract.h @@ -1,4 +1,4 @@ -/* ScreenAttract - Base class for all attraction screens. This class handles input and coin logic. */ +/* ScreenAttract - Base class for all attraction screens. This class handles input and coin logic. */ #ifndef ScreenAttract_H #define ScreenAttract_H