diff --git a/src/LifeMeter.h b/src/LifeMeter.h index 1fcf213a05..555106d025 100644 --- a/src/LifeMeter.h +++ b/src/LifeMeter.h @@ -8,7 +8,7 @@ class PlayerState; class PlayerStageStats; - +/** @brief The player's life. */ class LifeMeter : public ActorFrame { public: @@ -22,11 +22,17 @@ public: } virtual void OnLoadSong() {}; virtual void OnSongEnded() {}; - /* Change life after receiving a tap note grade. This *is* called for - * the head of hold notes. */ + /** + * @brief Change life after receiving a tap note grade. + * + * This *is* called for the head of hold notes. + * @param score the tap note grade in question. */ virtual void ChangeLife( TapNoteScore score ) = 0; - /* Change life after receiving a hold note grade. tscore is the score - * received for the initial tap note. */ + /** + * @brief Change life after receiving a hold note grade. + * + * @param hns the hold note grade in question. + * @param tns the score received for the initial tap note. */ virtual void ChangeLife( HoldNoteScore hns, TapNoteScore tns ) = 0; virtual void HandleTapScoreNone() = 0; virtual bool IsInDanger() const = 0; @@ -50,8 +56,10 @@ protected: #endif -/* - * (c) 2001-2003 Chris Danford +/** + * @file + * @author Chris Danford (c) 2001-2003 + * @section LICENSE * All rights reserved. * * Permission is hereby granted, free of charge, to any person obtaining a diff --git a/src/LifeMeterBar.h b/src/LifeMeterBar.h index f708185b66..087357c8be 100644 --- a/src/LifeMeterBar.h +++ b/src/LifeMeterBar.h @@ -1,5 +1,3 @@ -/* LifeMeterBar - The player's life represented as a bar. */ - #ifndef LIFEMETERBAR_H #define LIFEMETERBAR_H @@ -10,7 +8,7 @@ #include "ThemeMetric.h" class StreamDisplay; - +/** @brief The player's life represented as a bar. */ class LifeMeterBar : public LifeMeter { public: @@ -59,9 +57,10 @@ private: float m_fLifeDifficulty; // essentially same as pref int m_iProgressiveLifebar; // cached from prefs - int m_iMissCombo; // current number of progressive W5/miss - - int m_iComboToRegainLife; // combo needed before lifebar starts filling up after fail + /** @brief The current number of progressive W5/miss rankings. */ + int m_iMissCombo; + /** @brief The combo needed before the life bar starts to fill up after a Player failed. */ + int m_iComboToRegainLife; }; #endif diff --git a/src/LifeMeterBattery.h b/src/LifeMeterBattery.h index 67a40cd99c..964814fe7e 100644 --- a/src/LifeMeterBattery.h +++ b/src/LifeMeterBattery.h @@ -51,7 +51,9 @@ private: PercentageDisplay m_Percent; + /** @brief The sound played when a Player loses a life. */ RageSound m_soundLoseLife; + /** @brief The sound played when a Player gains a life. */ RageSound m_soundGainLife; }; diff --git a/src/LifeMeterTime.h b/src/LifeMeterTime.h index e318d480bf..1206fc2ba5 100644 --- a/src/LifeMeterTime.h +++ b/src/LifeMeterTime.h @@ -1,5 +1,3 @@ -/* LifeMeterTime - Battery life meter used in Survival. */ - #ifndef LifeMeterTime_H #define LifeMeterTime_H @@ -12,7 +10,7 @@ #include "MeterDisplay.h" #include "Quad.h" class StreamDisplay; - +/** @brief Battery life meter used in Survival. */ class LifeMeterTime : public LifeMeter { public: @@ -42,15 +40,17 @@ private: float m_fLifeTotalGainedSeconds; float m_fLifeTotalLostSeconds; - + /** @brief The sound played when time is gained at the start of each Song. */ RageSound m_soundGainLife; }; #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 diff --git a/src/LuaExpressionTransform.h b/src/LuaExpressionTransform.h index 3ca5234e8f..6a6ce463c1 100644 --- a/src/LuaExpressionTransform.h +++ b/src/LuaExpressionTransform.h @@ -1,4 +1,4 @@ -/* LuaExpressionTransform - Handle transforming a list of items. Cache item transforms based on fPositionOffsetFromCenter and iItemIndex for speed. */ +/* LuaExpressionTransform - */ #ifndef LuaExpressionTransform_H #define LuaExpressionTransform_H @@ -7,6 +7,10 @@ #include "LuaReference.h" #include +/** + * @brief Handle transforming a list of items + * + * Cache item transforms based on fPositionOffsetFromCenter and iItemIndex for speed. */ class LuaExpressionTransform { public: diff --git a/src/LyricsLoader.h b/src/LyricsLoader.h index 5f4d10551a..87b04b5be7 100644 --- a/src/LyricsLoader.h +++ b/src/LyricsLoader.h @@ -1,20 +1,24 @@ -/* LyricsLoader - Loads lyrics from an LRC file. */ - #ifndef LYRICS_LOADER_H #define LYRICS_LOADER_H class Song; - +/** @brief Loads lyrics from an LRC file. */ class LyricsLoader { public: + /** + * @brief Load the lyrics into the Song. + * @param sPath the path to the Lyrics. + * @param out the Song to receive the Lyrics. */ bool LoadFromLRCFile( const RString& sPath, Song &out ); }; #endif -/* - * (c) 2003 Kevin Slaughter, Glenn Maynard +/** + * @file + * @author Kevin Slaughter, Glenn Maynard (c) 2003 + * @section LICENSE * All rights reserved. * * Permission is hereby granted, free of charge, to any person obtaining a diff --git a/src/MessageManager.h b/src/MessageManager.h index e1101ff800..86d787b63c 100644 --- a/src/MessageManager.h +++ b/src/MessageManager.h @@ -1,5 +1,3 @@ -/* MessageManager - Control the world. */ - #ifndef MessageManager_H #define MessageManager_H @@ -8,6 +6,7 @@ struct lua_State; class LuaTable; class LuaReference; +/** @brief The various messages available to watch for. */ enum MessageID { Message_CurrentGameChanged, @@ -173,7 +172,7 @@ private: vector m_vsSubscribedTo; }; - +/** @brief Deliver messages to any part of the program as needed. */ class MessageManager { public: diff --git a/src/ModelManager.h b/src/ModelManager.h index c116f54ebe..c9a6822a61 100644 --- a/src/ModelManager.h +++ b/src/ModelManager.h @@ -1,4 +1,3 @@ -/* ModelManager - Interface for loading and releasing textures. */ #ifndef MODEL_MANAGER_H #define MODEL_MANAGER_H @@ -25,7 +24,10 @@ struct ModelManagerPrefs m_bDelayedUnload != rhs.m_bDelayedUnload; } }; - +/** + * @brief Class for loading and releasing textures. + * + * Funnily enough, the original documentation claimed this was an Interface. */ class ModelManager { public: @@ -36,7 +38,11 @@ public: void UnloadModel( RageModelGeometry *m ); // void ReloadAll(); - bool SetPrefs( const ModelManagerPrefs& prefs ); // returns true if needs display to be reset + /** + * @brief Set up new preferences. + * @param prefs the new preferences to set up. + * @return true if the display needs to be reset, false otherwise. */ + bool SetPrefs( const ModelManagerPrefs& prefs ); const ModelManagerPrefs& GetPrefs() { return m_Prefs; } protected: @@ -50,8 +56,10 @@ extern ModelManager* MODELMAN; // global and accessable from anywhere in our pro #endif -/* - * (c) 2003-2004 Chris Danford +/** + * @file + * @author Chris Danford (c) 2003-2004 + * @section LICENSE * All rights reserved. * * Permission is hereby granted, free of charge, to any person obtaining a diff --git a/src/arch/LoadingWindow/LoadingWindow_MacOSX.h b/src/arch/LoadingWindow/LoadingWindow_MacOSX.h index ddc595508a..53ba8a151e 100644 --- a/src/arch/LoadingWindow/LoadingWindow_MacOSX.h +++ b/src/arch/LoadingWindow/LoadingWindow_MacOSX.h @@ -1,10 +1,8 @@ -/* LoadingWindow_MacOSX - Loading window for OSX */ - #ifndef LOADING_WINDOW_MACOSX_H #define LOADING_WINDOW_MACOSX_H #include "LoadingWindow.h" - +/** @brief Loading window for Mac OS X. */ class LoadingWindow_MacOSX : public LoadingWindow { public: @@ -16,8 +14,10 @@ public: #endif -/* - * (c) 2003-2005, 2008 Steve Checkoway +/** + * @file + * @author Steve Checkoway (c) 2003-2005, 2008 + * @section LICENSE * All rights reserved. * * Permission is hereby granted, free of charge, to any person obtaining a