diff --git a/src/HighScore.h b/src/HighScore.h index ba493e4d10..fb99deb4c0 100644 --- a/src/HighScore.h +++ b/src/HighScore.h @@ -1,5 +1,3 @@ -/** @brief HighScore - Player scoring data that persists between sessions. */ - #ifndef HIGH_SCORE_H #define HIGH_SCORE_H @@ -13,7 +11,9 @@ struct RadarValues; struct lua_State; struct HighScoreImpl; -/** @brief The high score that is earned by a player. */ +/** @brief The high score that is earned by a player. + * + * This is scoring data that is persisted between sessions. */ struct HighScore { HighScore(); diff --git a/src/Player.cpp b/src/Player.cpp index fd3a45e715..87625838bc 100644 --- a/src/Player.cpp +++ b/src/Player.cpp @@ -91,8 +91,10 @@ public: RString ATTACK_DISPLAY_X_NAME( size_t p, size_t both_sides ) { return "AttackDisplayXOffset" + (both_sides ? RString("BothSides") : ssprintf("OneSideP%d",int(p+1)) ); } -/* Distance to search for a note in Step(), in seconds. */ -// TODO: This should be calculated based on the max size of the current judgment windows. +/** + * @brief Distance to search for a note in Step(), in seconds. + * + * TODO: This should be calculated based on the max size of the current judgment windows. */ static const float StepSearchDistance = 1.0f; void TimingWindowSecondsInit( size_t /*TimingWindow*/ i, RString &sNameOut, float &defaultValueOut ) diff --git a/src/Player.h b/src/Player.h index 82118d95ce..4afd0c76e9 100644 --- a/src/Player.h +++ b/src/Player.h @@ -1,5 +1,3 @@ -/* Player - Accepts input, knocks down TapNotes that were stepped on, and keeps score for the player. */ - #ifndef PLAYER_H #define PLAYER_H @@ -37,6 +35,7 @@ AutoScreenMessage( SM_1000Combo ); AutoScreenMessage( SM_ComboStopped ); AutoScreenMessage( SM_ComboContinuing ); +/** @brief Accepts input, knocks down TapNotes that were stepped on, and keeps score for the player. */ class Player: public ActorFrame { public: @@ -145,7 +144,9 @@ protected: bool m_bLoaded; + /** @brief The player's present state. */ PlayerState *m_pPlayerState; + /** @brief The player's present stage stats. */ PlayerStageStats *m_pPlayerStageStats; float m_fNoteFieldHeight; diff --git a/src/ScoreDisplayLifeTime.h b/src/ScoreDisplayLifeTime.h index e9bd02500e..8972c97899 100644 --- a/src/ScoreDisplayLifeTime.h +++ b/src/ScoreDisplayLifeTime.h @@ -1,5 +1,3 @@ -/* ScoreDisplayLifeTime - Display a updating count of life time remaining. */ - #ifndef ScoreDisplayLifeTime_H #define ScoreDisplayLifeTime_H @@ -7,6 +5,10 @@ #include "BitmapText.h" #include "AutoActor.h" +/** + * @breif Display a updating count of life time remaining. + * + * This is mainly used for Survival mode. */ class ScoreDisplayLifeTime : public ScoreDisplay { public: diff --git a/src/ScreenEvaluation.h b/src/ScreenEvaluation.h index 5053600aa0..3e6c3f1280 100644 --- a/src/ScreenEvaluation.h +++ b/src/ScreenEvaluation.h @@ -1,5 +1,3 @@ -/* ScreenEvaluation - Shows the player their score after gameplay has ended. */ - #ifndef SCREEN_EVALUATION_H #define SCREEN_EVALUATION_H @@ -14,31 +12,38 @@ #include "ThemeMetric.h" #include "RollingNumbers.h" -const int MAX_SONGS_TO_SHOW = 5; // In summary, we show last 3 stages, plus extra stages if passed +/** + * @brief How many songs are shown at the end? + * + * In the traditional summary, only the last three stages are shown. + * If any extra stages are passed, those get shown as well. */ +const int MAX_SONGS_TO_SHOW = 5; +/** @brief The different judgment lines shown. */ enum JudgmentLine { - JudgmentLine_W1, - JudgmentLine_W2, - JudgmentLine_W3, - JudgmentLine_W4, - JudgmentLine_W5, - JudgmentLine_Miss, - JudgmentLine_Held, - JudgmentLine_MaxCombo, - NUM_JudgmentLine, + JudgmentLine_W1, /**< The line showing absolutely perfect hits. */ + JudgmentLine_W2, /**< The line showing just-a-smidge-off perfect hits. */ + JudgmentLine_W3, /**< The line showing almost perfect hits. */ + JudgmentLine_W4, /**< The line showing hits that were not that good. */ + JudgmentLine_W5, /**< The line showing hits that were almost missed. */ + JudgmentLine_Miss, /**< The line showing missed notes. */ + JudgmentLine_Held, /**< The line showing held down notes. */ + JudgmentLine_MaxCombo, /**< The line showing the player's max combo. */ + NUM_JudgmentLine, /**< The number of judgment lines available. */ JudgmentLine_Invalid }; +/** @brief The number of details based on the radar categories. */ enum DetailLine { - DetailLine_NumSteps, - DetailLine_Jumps, - DetailLine_Holds, - DetailLine_Mines, - DetailLine_Hands, - DetailLine_Rolls, - NUM_DetailLine + DetailLine_NumSteps, /**< The number of steps hit. */ + DetailLine_Jumps, /**< The number of jumps hit together. */ + DetailLine_Holds, /**< The number of holds held. */ + DetailLine_Mines, /**< The number of mines avoided. */ + DetailLine_Hands, /**< The number of hands hit (somehow) */ + DetailLine_Rolls, /**< The number of rolls hit repeatedly. */ + NUM_DetailLine /**< The nuber of detailed lines. */ }; - +/** @brief Shows the player their score after gameplay has ended. */ class ScreenEvaluation : public ScreenWithMenuElements { public: @@ -69,7 +74,7 @@ protected: // grade area AutoActor m_sprGradeFrame[NUM_PLAYERS]; - GradeDisplay m_Grades[NUM_PLAYERS]; + GradeDisplay m_Grades[NUM_PLAYERS]; // points area bool m_bNewSongsUnlocked; @@ -91,7 +96,7 @@ protected: // judgment area AutoActor m_sprSharedJudgmentLineLabels[NUM_JudgmentLine]; - RollingNumbers m_textJudgmentLineNumber[NUM_JudgmentLine][NUM_PLAYERS]; + RollingNumbers m_textJudgmentLineNumber[NUM_JudgmentLine][NUM_PLAYERS]; // stats area AutoActor m_sprDetailFrame[NUM_PLAYERS]; @@ -99,7 +104,7 @@ protected: // score area AutoActor m_sprScoreLabel; - RollingNumbers m_textScore[NUM_PLAYERS]; + RollingNumbers m_textScore[NUM_PLAYERS]; // time area AutoActor m_sprTimeLabel; @@ -108,14 +113,16 @@ protected: RageSound m_soundStart; // sound played if the player passes or fails ThemeMetric SUMMARY; - + /** @brief Did a player save a screenshot of their score? */ bool m_bSavedScreenshot[NUM_PLAYERS]; }; #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