diff --git a/src/DisplayResolutions.h b/src/DisplayResolutions.h index 681d296e78..3788942db2 100644 --- a/src/DisplayResolutions.h +++ b/src/DisplayResolutions.h @@ -2,16 +2,24 @@ #define DisplayResolutions_H #include - +/** @brief The dimensions of the program. */ class DisplayResolution { public: + /** @brief The width of the program. */ int iWidth; + /** @brief The height of the program. */ int iHeight; + /** @brief Is this display stretched/used for widescreen? */ bool bStretched; + /** + * @brief Determine if one DisplayResolution is less than the other. + * @param other the other DisplayResolution to check. + * @return true if this DisplayResolution is less than the other, or false otherwise. */ bool operator<( const DisplayResolution &other ) const { +/** @brief A quick way to compare the two DisplayResolutions. */ #define COMPARE(x) if( x != other.x ) return x < other.x; COMPARE( iWidth ); COMPARE( iHeight ); @@ -20,13 +28,15 @@ public: return false; } }; - +/** @brief The collection of DisplayResolutions available within the program. */ typedef set DisplayResolutions; #endif -/* - * (c) 2001-2005 Chris Danford +/** + * @file + * @author Chris Danford (c) 2001-2005 + * @section LICENSE * All rights reserved. * * Permission is hereby granted, free of charge, to any person obtaining a diff --git a/src/ScreenManager.h b/src/ScreenManager.h index d665dc2b6c..9b475a1338 100644 --- a/src/ScreenManager.h +++ b/src/ScreenManager.h @@ -1,5 +1,3 @@ -/* ScreenManager - Manager/container for Screens. */ - #ifndef SCREEN_MANAGER_H #define SCREEN_MANAGER_H @@ -11,7 +9,7 @@ class Screen; struct Menu; struct lua_State; class InputEventPlus; - +/** @brief Manager/container for Screens. */ class ScreenManager { public: @@ -26,7 +24,13 @@ public: // Main screen stack management void SetNewScreen( const RString &sName ); void AddNewScreenToTop( const RString &sName, ScreenMessage SendOnPop=SM_None ); - void PrepareScreen( const RString &sScreenName ); // creates and caches screen so that the next call to SetNewScreen for the prep'd screen will be very quick. + /** + * @brief Create and cache the requested Screen. + * + * This is so that the next call to SetNewScreen for this Screen + * will be very quick. + * @param sScreenName the Screen to prepare. */ + void PrepareScreen( const RString &sScreenName ); void GroupScreen( const RString &sScreenName ); void PersistantScreen( const RString &sScreenName ); void PopTopScreen( ScreenMessage SM ); @@ -48,9 +52,13 @@ public: void ThemeChanged(); void ReloadOverlayScreens(); - /* Return true if the given screen is in the main screen stack, but not the - * bottommost screen. If true, the screen should usually exit by popping - * itself, not by loading another screen. */ + /** + * @brief Is this Screen in the main Screen stack, but not the bottommost Screen? + * + * If this function returns true, the screen should exit by popping + * itself, not by loading another Screen. + * @param pScreen the Screen to check. + * @return true if it's on the stack while not on the bottom, or false otherwise. */ bool IsStackedScreen( const Screen *pScreen ) const; // Lua @@ -87,9 +95,11 @@ public: private: RageSound m_soundStart; + /** @brief The sound played when a coin has been put into the machine. */ RageSound m_soundCoin; RageSound m_soundCancel; RageSound m_soundInvalid; + /** @brief The sound played when a Player wishes to take a picture of their Score. */ RageSound m_soundScreenshot; }; @@ -98,8 +108,10 @@ extern ScreenManager* SCREENMAN; // global and accessable from anywhere in our p #endif -/* - * (c) 2001-2003 Chris Danford, Glenn Maynard +/** + * @file + * @author Chris Danford, Glenn Maynard (c) 2001-2003 + * @section LICENSE * All rights reserved. * * Permission is hereby granted, free of charge, to any person obtaining a diff --git a/src/StatsManager.h b/src/StatsManager.h index ca990a4eec..872dae7c31 100644 --- a/src/StatsManager.h +++ b/src/StatsManager.h @@ -1,10 +1,8 @@ -/* StatsManager - Managed non-persisted statistics. */ - #ifndef StatsManager_H #define StatsManager_H #include "StageStats.h" - +/** @brief Managed non-persisted statistics. */ class StatsManager { public: @@ -13,7 +11,11 @@ public: void Reset(); - StageStats m_CurStageStats; // current stage (not necessarily passed if Extra Stage) + /** + * @brief The current Stage stats. + * + * This is not necessarily passed stage stats if this is an Extra Stage. */ + StageStats m_CurStageStats; vector m_vPlayedStageStats; // Only the latest 3 normal songs + passed extra stages. @@ -40,8 +42,10 @@ extern StatsManager* STATSMAN; // global and accessable from anywhere in our pro #endif -/* - * (c) 2001-2004 Chris Danford +/** + * @file + * @author Chris Danford (c) 2001-2004 + * @section LICENSE * All rights reserved. * * Permission is hereby granted, free of charge, to any person obtaining a