From 9d13036e0872a56e1319c25bea16c868b1883397 Mon Sep 17 00:00:00 2001 From: Jason Felds Date: Sat, 19 Feb 2011 12:26:18 -0500 Subject: [PATCH] Add @briefs to the Luna classes. Yeah...there was a lot. */ --- src/Actor.cpp | 1 + src/ActorFrame.cpp | 1 + src/ActorFrameTexture.cpp | 1 + src/ActorMultiTexture.cpp | 1 + src/ActorProxy.cpp | 1 + src/ActorScroller.cpp | 1 + src/ActorSound.cpp | 1 + src/AnnouncerManager.cpp | 1 + src/Banner.cpp | 1 + src/BitmapText.cpp | 2 ++ src/Character.cpp | 1 + src/CharacterManager.cpp | 1 + src/ComboGraph.cpp | 1 + src/ControllerStateDisplay.cpp | 3 ++- src/Course.cpp | 2 ++ src/CourseContentsList.cpp | 1 + src/CryptManager.cpp | 1 + src/DifficultyIcon.cpp | 1 + src/DifficultyList.cpp | 1 + src/FadingBanner.cpp | 1 + src/Game.cpp | 1 + src/GameCommand.cpp | 1 + src/GameManager.cpp | 1 + src/GameSoundManager.cpp | 1 + src/GameState.cpp | 1 + src/GradeDisplay.cpp | 1 + src/GraphDisplay.cpp | 1 + src/GrooveRadar.cpp | 1 + src/HelpDisplay.cpp | 2 ++ src/HoldJudgment.cpp | 1 + src/LifeMeter.cpp | 1 + src/LifeMeterBattery.cpp | 1 + src/LuaBinding.h | 1 + src/MemoryCardManager.cpp | 1 + src/MenuTimer.cpp | 1 + src/MessageManager.cpp | 1 + src/ModIconRow.cpp | 1 + src/Model.cpp | 1 + src/NoteSkinManager.cpp | 1 + src/PaneDisplay.cpp | 1 + src/PercentageDisplay.cpp | 1 + src/Player.cpp | 1 + src/PlayerStageStats.cpp | 1 + src/PlayerState.cpp | 1 + src/PrefsManager.cpp | 1 + src/Profile.cpp | 1 + src/ProfileManager.cpp | 1 + src/RadarValues.cpp | 1 + src/RageDisplay.cpp | 2 ++ src/RageFile.cpp | 1 + src/RageFileManager.cpp | 1 + src/RageInput.cpp | 1 + src/RageSound.cpp | 1 + src/RageTexture.cpp | 1 + src/RageTextureRenderTarget.cpp | 1 + src/RollingNumbers.cpp | 1 + src/ScoreDisplayAliveTime.cpp | 1 + src/ScoreDisplayCalories.cpp | 1 + src/Screen.cpp | 1 + src/ScreenAttract.cpp | 1 + src/ScreenEdit.cpp | 1 + src/ScreenEvaluation.cpp | 1 + src/ScreenGameplay.cpp | 2 ++ src/ScreenHowToPlay.cpp | 1 + src/ScreenManager.cpp | 1 + src/ScreenNameEntryTraditional.cpp | 1 + src/ScreenNetEvaluation.cpp | 1 + src/ScreenOptions.cpp | 1 + src/ScreenPlayerOptions.cpp | 1 + src/ScreenProfileLoad.cpp | 1 + src/ScreenProfileSave.cpp | 1 + src/ScreenPrompt.cpp | 2 ++ src/ScreenSelectMaster.cpp | 1 + src/ScreenSelectMusic.cpp | 1 + src/ScreenSelectProfile.cpp | 1 + src/ScreenTextEntry.cpp | 2 +- src/ScreenWithMenuElements.cpp | 3 ++- src/Song.cpp | 1 + src/SongManager.cpp | 1 + src/Sprite.cpp | 1 + src/StageStats.cpp | 1 + src/StatsManager.cpp | 1 + src/StepsDisplay.cpp | 1 + src/Style.cpp | 1 + src/TextBanner.cpp | 1 + src/ThemeManager.cpp | 1 + src/TimingData.cpp | 1 + src/Trail.cpp | 3 +++ src/UnlockManager.cpp | 2 ++ src/WheelBase.cpp | 1 + src/WorkoutGraph.cpp | 1 + 91 files changed, 102 insertions(+), 3 deletions(-) diff --git a/src/Actor.cpp b/src/Actor.cpp index 153b947950..ac61bb1e85 100644 --- a/src/Actor.cpp +++ b/src/Actor.cpp @@ -1307,6 +1307,7 @@ Actor::TweenInfo &Actor::TweenInfo::operator=( const TweenInfo &rhs ) // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the Actor. */ class LunaActor : public Luna { public: diff --git a/src/ActorFrame.cpp b/src/ActorFrame.cpp index 672cac0279..bbe12260a5 100644 --- a/src/ActorFrame.cpp +++ b/src/ActorFrame.cpp @@ -451,6 +451,7 @@ void ActorFrame::SetDrawByZPosition( bool b ) // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the ActorFrame. */ class LunaActorFrame : public Luna { public: diff --git a/src/ActorFrameTexture.cpp b/src/ActorFrameTexture.cpp index f86cfa225d..9b36b85e5e 100644 --- a/src/ActorFrameTexture.cpp +++ b/src/ActorFrameTexture.cpp @@ -67,6 +67,7 @@ void ActorFrameTexture::DrawPrimitives() // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the ActorFrameTexture. */ class LunaActorFrameTexture : public Luna { public: diff --git a/src/ActorMultiTexture.cpp b/src/ActorMultiTexture.cpp index 1b69a5c0f0..7b7fd85f21 100644 --- a/src/ActorMultiTexture.cpp +++ b/src/ActorMultiTexture.cpp @@ -134,6 +134,7 @@ bool ActorMultiTexture::EarlyAbortDraw() const // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the ActorMultiTexture. */ class LunaActorMultiTexture: public Luna { public: diff --git a/src/ActorProxy.cpp b/src/ActorProxy.cpp index 8429ecab96..38938818d0 100644 --- a/src/ActorProxy.cpp +++ b/src/ActorProxy.cpp @@ -33,6 +33,7 @@ void ActorProxy::LoadFromNode( const XNode* pNode ) // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the ActorProxy. */ class LunaActorProxy: public Luna { public: diff --git a/src/ActorScroller.cpp b/src/ActorScroller.cpp index 3d65ad01d2..91f1927a7c 100644 --- a/src/ActorScroller.cpp +++ b/src/ActorScroller.cpp @@ -309,6 +309,7 @@ void ActorScroller::PositionItemsAndDrawPrimitives( bool bDrawPrimitives ) // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the ActorScroller. */ class LunaActorScroller: public Luna { public: diff --git a/src/ActorSound.cpp b/src/ActorSound.cpp index b70fe7fce6..054ee2c2a7 100644 --- a/src/ActorSound.cpp +++ b/src/ActorSound.cpp @@ -53,6 +53,7 @@ void ActorSound::LoadFromNode( const XNode* pNode ) // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the ActorSound. */ class LunaActorSound: public Luna { public: diff --git a/src/AnnouncerManager.cpp b/src/AnnouncerManager.cpp index 888321f2d8..50759c01dd 100644 --- a/src/AnnouncerManager.cpp +++ b/src/AnnouncerManager.cpp @@ -166,6 +166,7 @@ void AnnouncerManager::NextAnnouncer() // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the AnnouncerManager. */ class LunaAnnouncerManager: public Luna { public: diff --git a/src/Banner.cpp b/src/Banner.cpp index 485722754c..eec43af0de 100644 --- a/src/Banner.cpp +++ b/src/Banner.cpp @@ -232,6 +232,7 @@ void Banner::LoadFromSortOrder( SortOrder so ) // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the Banner. */ class LunaBanner: public Luna { public: diff --git a/src/BitmapText.cpp b/src/BitmapText.cpp index d65911721a..a67f670aa4 100644 --- a/src/BitmapText.cpp +++ b/src/BitmapText.cpp @@ -794,6 +794,8 @@ void BitmapText::Attribute::FromStack( lua_State *L, int iPos ) // lua start #include "FontCharAliases.h" + +/** @brief Allow Lua to have access to the BitmapText. */ class LunaBitmapText: public Luna { public: diff --git a/src/Character.cpp b/src/Character.cpp index ac8a8da14d..a925c8b563 100644 --- a/src/Character.cpp +++ b/src/Character.cpp @@ -198,6 +198,7 @@ void Character::UndemandGraphics() // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the Character. */ class LunaCharacter: public Luna { public: diff --git a/src/CharacterManager.cpp b/src/CharacterManager.cpp index 7a0b6b6fa3..f00522ec7c 100644 --- a/src/CharacterManager.cpp +++ b/src/CharacterManager.cpp @@ -120,6 +120,7 @@ Character* CharacterManager::GetCharacterFromID( RString sCharacterID ) // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the CharacterManager. */ class LunaCharacterManager: public Luna { public: diff --git a/src/ComboGraph.cpp b/src/ComboGraph.cpp index 21d157b8bd..01f22e373a 100644 --- a/src/ComboGraph.cpp +++ b/src/ComboGraph.cpp @@ -112,6 +112,7 @@ void ComboGraph::Set( const StageStats &s, const PlayerStageStats &pss ) // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the ComboGraph. */ class LunaComboGraph: public Luna { public: diff --git a/src/ControllerStateDisplay.cpp b/src/ControllerStateDisplay.cpp index 12b9cc5471..d97c664b64 100644 --- a/src/ControllerStateDisplay.cpp +++ b/src/ControllerStateDisplay.cpp @@ -95,7 +95,8 @@ void ControllerStateDisplay::Update( float fDelta ) } } -// lua start + +/** @brief Allow Lua to have access to the ControllerStateDisplay. */ class LunaControllerStateDisplay: public Luna { public: diff --git a/src/Course.cpp b/src/Course.cpp index 2833f434ed..278112f490 100644 --- a/src/Course.cpp +++ b/src/Course.cpp @@ -88,6 +88,7 @@ int CourseEntry::GetNumModChanges() const // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the CourseEntry. */ class LunaCourseEntry: public Luna { public: @@ -1045,6 +1046,7 @@ bool Course::Matches( RString sGroup, RString sCourse ) const // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the Course. */ class LunaCourse: public Luna { public: diff --git a/src/CourseContentsList.cpp b/src/CourseContentsList.cpp index 14b332e0bc..7b03b083c2 100644 --- a/src/CourseContentsList.cpp +++ b/src/CourseContentsList.cpp @@ -145,6 +145,7 @@ void CourseContentsList::SetItemFromGameState( Actor *pActor, int iCourseEntryIn // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the CourseContentsList. */ class LunaCourseContentsList: public Luna { public: diff --git a/src/CryptManager.cpp b/src/CryptManager.cpp index 28c768c6a2..5841a103b3 100644 --- a/src/CryptManager.cpp +++ b/src/CryptManager.cpp @@ -430,6 +430,7 @@ RString CryptManager::GenerateRandomUUID() // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the CryptManager. */ class LunaCryptManager: public Luna { public: diff --git a/src/DifficultyIcon.cpp b/src/DifficultyIcon.cpp index e2f8c450b5..3a7439b45d 100644 --- a/src/DifficultyIcon.cpp +++ b/src/DifficultyIcon.cpp @@ -95,6 +95,7 @@ void DifficultyIcon::SetFromDifficulty( Difficulty dc ) // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the DifficultyIcon. */ class LunaDifficultyIcon: public Luna { public: diff --git a/src/DifficultyList.cpp b/src/DifficultyList.cpp index 153f1beaa7..f8dfa19440 100644 --- a/src/DifficultyList.cpp +++ b/src/DifficultyList.cpp @@ -379,6 +379,7 @@ void StepsDisplayList::HandleMessage( const Message &msg ) // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the StepsDisplayList. */ class LunaStepsDisplayList: public Luna { public: diff --git a/src/FadingBanner.cpp b/src/FadingBanner.cpp index f11baa0421..cc1948ef2a 100644 --- a/src/FadingBanner.cpp +++ b/src/FadingBanner.cpp @@ -255,6 +255,7 @@ void FadingBanner::LoadCourseFallback() // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the FadingBanner. */ class LunaFadingBanner: public Luna { public: diff --git a/src/Game.cpp b/src/Game.cpp index 036b3f2e1c..2e1c09511c 100644 --- a/src/Game.cpp +++ b/src/Game.cpp @@ -42,6 +42,7 @@ const Game::PerButtonInfo *Game::GetPerButtonInfo( GameButton gb ) const // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the Game. */ class LunaGame: public Luna { public: diff --git a/src/GameCommand.cpp b/src/GameCommand.cpp index b6717b8fb6..2bd5c7051a 100644 --- a/src/GameCommand.cpp +++ b/src/GameCommand.cpp @@ -855,6 +855,7 @@ bool GameCommand::IsZero() const #include "Steps.h" #include "Character.h" +/** @brief Allow Lua to have access to the GameCommand. */ class LunaGameCommand: public Luna { public: diff --git a/src/GameManager.cpp b/src/GameManager.cpp index c904915665..56a60a5a45 100644 --- a/src/GameManager.cpp +++ b/src/GameManager.cpp @@ -3103,6 +3103,7 @@ const Style* GameManager::GameAndStringToStyle( const Game *game, RString sStyle // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the GameManager. */ class LunaGameManager: public Luna { public: diff --git a/src/GameSoundManager.cpp b/src/GameSoundManager.cpp index 9034b86a34..e19cd42bd6 100644 --- a/src/GameSoundManager.cpp +++ b/src/GameSoundManager.cpp @@ -781,6 +781,7 @@ float GameSoundManager::GetPlayerBalance( PlayerNumber pn ) #include "LuaBinding.h" +/** @brief Allow Lua to have access to the GameSoundManager. */ class LunaGameSoundManager: public Luna { public: diff --git a/src/GameState.cpp b/src/GameState.cpp index 61fcc69f45..ec68e416a0 100644 --- a/src/GameState.cpp +++ b/src/GameState.cpp @@ -2174,6 +2174,7 @@ MultiPlayer GetNextEnabledMultiPlayer( MultiPlayer mp ) #include "LuaBinding.h" #include "Game.h" +/** @brief Allow Lua to have access to the GameState. */ class LunaGameState: public Luna { public: diff --git a/src/GradeDisplay.cpp b/src/GradeDisplay.cpp index 7760ca877b..2648f50844 100644 --- a/src/GradeDisplay.cpp +++ b/src/GradeDisplay.cpp @@ -36,6 +36,7 @@ void GradeDisplay::SetGrade( Grade grade ) // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the GradeDisplay. */ class LunaGradeDisplay: public Luna { public: diff --git a/src/GraphDisplay.cpp b/src/GraphDisplay.cpp index adf88abfa5..ced69f6e27 100644 --- a/src/GraphDisplay.cpp +++ b/src/GraphDisplay.cpp @@ -275,6 +275,7 @@ void GraphDisplay::UpdateVerts() // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the GraphDisplay. */ class LunaGraphDisplay: public Luna { public: diff --git a/src/GrooveRadar.cpp b/src/GrooveRadar.cpp index 06ce8d4c9a..d9244af486 100644 --- a/src/GrooveRadar.cpp +++ b/src/GrooveRadar.cpp @@ -187,6 +187,7 @@ void GrooveRadar::GrooveRadarValueMap::DrawPrimitives() // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the GrooveRadar. */ class LunaGrooveRadar: public Luna { public: diff --git a/src/HelpDisplay.cpp b/src/HelpDisplay.cpp index bef56bf06e..59d464629d 100644 --- a/src/HelpDisplay.cpp +++ b/src/HelpDisplay.cpp @@ -62,6 +62,8 @@ void HelpDisplay::Update( float fDeltaTime ) #include "LuaBinding.h" #include "FontCharAliases.h" + +/** @brief Allow Lua to have access to the HelpDisplay. */ class LunaHelpDisplay: public Luna { public: diff --git a/src/HoldJudgment.cpp b/src/HoldJudgment.cpp index fb9d99a435..ccef1e8b1c 100644 --- a/src/HoldJudgment.cpp +++ b/src/HoldJudgment.cpp @@ -95,6 +95,7 @@ void HoldJudgment::HandleMessage( const Message &msg ) // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the HoldJudgment. */ class LunaHoldJudgment: public Luna { public: diff --git a/src/LifeMeter.cpp b/src/LifeMeter.cpp index e542576471..be9adee28a 100644 --- a/src/LifeMeter.cpp +++ b/src/LifeMeter.cpp @@ -19,6 +19,7 @@ LifeMeter *LifeMeter::MakeLifeMeter( SongOptions::LifeType t ) // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the LifeMeter. */ class LunaLifeMeter: public Luna { public: diff --git a/src/LifeMeterBattery.cpp b/src/LifeMeterBattery.cpp index ce0abf7365..207eea50a9 100644 --- a/src/LifeMeterBattery.cpp +++ b/src/LifeMeterBattery.cpp @@ -240,6 +240,7 @@ void LifeMeterBattery::Update( float fDeltaTime ) // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the LifeMeterBattery. */ class LunaLifeMeterBattery: public Luna { public: diff --git a/src/LuaBinding.h b/src/LuaBinding.h index 0917fa108f..a56ac901bb 100644 --- a/src/LuaBinding.h +++ b/src/LuaBinding.h @@ -32,6 +32,7 @@ protected: static int PushEqual( lua_State *L ); }; +/** @brief Allow the binding of Lua to various classes. */ template class Luna: public LuaBinding { diff --git a/src/MemoryCardManager.cpp b/src/MemoryCardManager.cpp index 4573598817..bdb5a7f7ec 100644 --- a/src/MemoryCardManager.cpp +++ b/src/MemoryCardManager.cpp @@ -713,6 +713,7 @@ void MemoryCardManager::UnPauseMountingThread() // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the MemoryCardManager. */ class LunaMemoryCardManager: public Luna { public: diff --git a/src/MenuTimer.cpp b/src/MenuTimer.cpp index 0a277fa766..5cf0e63017 100644 --- a/src/MenuTimer.cpp +++ b/src/MenuTimer.cpp @@ -194,6 +194,7 @@ void MenuTimer::SetText( float fSeconds ) // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the MenuTimer. */ class LunaMenuTimer: public Luna { public: diff --git a/src/MessageManager.cpp b/src/MessageManager.cpp index ee4dcd6e9b..5fecc2d781 100644 --- a/src/MessageManager.cpp +++ b/src/MessageManager.cpp @@ -273,6 +273,7 @@ void MessageSubscriber::UnsubscribeAll() // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the MessageManager. */ class LunaMessageManager: public Luna { public: diff --git a/src/ModIconRow.cpp b/src/ModIconRow.cpp index 19e0785a10..996b0da158 100644 --- a/src/ModIconRow.cpp +++ b/src/ModIconRow.cpp @@ -176,6 +176,7 @@ void ModIconRow::SetFromGameState() // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the ModIconRow. */ class LunaModIconRow: public Luna { public: diff --git a/src/Model.cpp b/src/Model.cpp index f61bc45567..b285611649 100644 --- a/src/Model.cpp +++ b/src/Model.cpp @@ -769,6 +769,7 @@ bool Model::MaterialsNeedNormals() const // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the Model. */ class LunaModel: public Luna { public: diff --git a/src/NoteSkinManager.cpp b/src/NoteSkinManager.cpp index 602073e9a9..9e0ed0834f 100644 --- a/src/NoteSkinManager.cpp +++ b/src/NoteSkinManager.cpp @@ -444,6 +444,7 @@ RString NoteSkinManager::GetPathFromDirAndFile( const RString &sDir, const RStri // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the NoteSkinManager. */ class LunaNoteSkinManager: public Luna { public: diff --git a/src/PaneDisplay.cpp b/src/PaneDisplay.cpp index 88bb957b4e..cdd89c681f 100644 --- a/src/PaneDisplay.cpp +++ b/src/PaneDisplay.cpp @@ -276,6 +276,7 @@ void PaneDisplay::SetFromGameState() // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the PaneDisplay. */ class LunaPaneDisplay: public Luna { public: diff --git a/src/PercentageDisplay.cpp b/src/PercentageDisplay.cpp index 66dcacc8f6..31dc11c7a0 100644 --- a/src/PercentageDisplay.cpp +++ b/src/PercentageDisplay.cpp @@ -207,6 +207,7 @@ bool PercentageDisplay::ShowDancePointsNotPercentage() const #include "LuaBinding.h" +/** @brief Allow Lua to have access to the PercentageDisplay. */ class LunaPercentageDisplay: public Luna { public: diff --git a/src/Player.cpp b/src/Player.cpp index 9e8a7c4d58..944489856d 100644 --- a/src/Player.cpp +++ b/src/Player.cpp @@ -3240,6 +3240,7 @@ RString Player::ApplyRandomAttack() // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the Player. */ class LunaPlayer: public Luna { public: diff --git a/src/PlayerStageStats.cpp b/src/PlayerStageStats.cpp index 69a4dbe3b7..d1b0e08d4a 100644 --- a/src/PlayerStageStats.cpp +++ b/src/PlayerStageStats.cpp @@ -668,6 +668,7 @@ LuaFunction( FormatPercentScore, PlayerStageStats::FormatPercentScore( FArg(1) ) // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the PlayerStageStats. */ class LunaPlayerStageStats: public Luna { public: diff --git a/src/PlayerState.cpp b/src/PlayerState.cpp index 41ebdbc9b3..aa512ecbaf 100644 --- a/src/PlayerState.cpp +++ b/src/PlayerState.cpp @@ -192,6 +192,7 @@ int PlayerState::GetSumOfActiveAttackLevels() const // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the PlayerState. */ class LunaPlayerState: public Luna { public: diff --git a/src/PrefsManager.cpp b/src/PrefsManager.cpp index 2ced597a9e..3d32672c58 100644 --- a/src/PrefsManager.cpp +++ b/src/PrefsManager.cpp @@ -521,6 +521,7 @@ RString PrefsManager::GetPreferencesSection() const // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the PrefsManager. */ class LunaPrefsManager: public Luna { public: diff --git a/src/Profile.cpp b/src/Profile.cpp index 22b071a4d6..b3d48827d6 100644 --- a/src/Profile.cpp +++ b/src/Profile.cpp @@ -1937,6 +1937,7 @@ RString Profile::MakeFileNameNoExtension( RString sFileNameBeginning, int iIndex // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the Profile. */ class LunaProfile: public Luna { public: diff --git a/src/ProfileManager.cpp b/src/ProfileManager.cpp index 65db1110c7..81f1f40ff9 100644 --- a/src/ProfileManager.cpp +++ b/src/ProfileManager.cpp @@ -799,6 +799,7 @@ int ProfileManager::GetNumLocalProfiles() const // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the ProfileManager. */ class LunaProfileManager: public Luna { public: diff --git a/src/RadarValues.cpp b/src/RadarValues.cpp index c87b4fe8c7..890bec2fa6 100644 --- a/src/RadarValues.cpp +++ b/src/RadarValues.cpp @@ -91,6 +91,7 @@ void RadarValues::FromString( RString sRadarValues ) // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the RadarValues. */ class LunaRadarValues: public Luna { public: diff --git a/src/RageDisplay.cpp b/src/RageDisplay.cpp index c622671608..14eb9a7ed5 100644 --- a/src/RageDisplay.cpp +++ b/src/RageDisplay.cpp @@ -994,6 +994,8 @@ void RageCompiledGeometry::Set( const vector &vMeshes, bool bNeedsNormal // lua start #include "LuaBinding.h" + +/** @brief Allow Lua to have access to the RageDisplay. */ class LunaRageDisplay: public Luna { public: diff --git a/src/RageFile.cpp b/src/RageFile.cpp index 89133252e8..e59057a5da 100644 --- a/src/RageFile.cpp +++ b/src/RageFile.cpp @@ -316,6 +316,7 @@ int32_t FileReading::read_32_le( RageFileBasic &f, RString &sError ) // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the RageFile. */ class LunaRageFile: public Luna { public: diff --git a/src/RageFileManager.cpp b/src/RageFileManager.cpp index deaa84bc2c..f1fad415d4 100644 --- a/src/RageFileManager.cpp +++ b/src/RageFileManager.cpp @@ -1036,6 +1036,7 @@ unsigned int GetHashForDirectory( const RString &sDir ) // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the RageFileManager. */ class LunaRageFileManager: public Luna { public: diff --git a/src/RageInput.cpp b/src/RageInput.cpp index 99c9d6eba5..fa5b29d8f9 100644 --- a/src/RageInput.cpp +++ b/src/RageInput.cpp @@ -176,6 +176,7 @@ RString RageInput::GetDisplayDevicesString() const // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the RageInput. */ class LunaRageInput: public Luna { public: diff --git a/src/RageSound.cpp b/src/RageSound.cpp index 456df5275f..fa19d74b6c 100644 --- a/src/RageSound.cpp +++ b/src/RageSound.cpp @@ -647,6 +647,7 @@ void RageSound::SetStopModeFromString( const RString &sStopMode ) // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the RageSound. */ class LunaRageSound: public Luna { public: diff --git a/src/RageTexture.cpp b/src/RageTexture.cpp index 5d98403747..c1eed7d324 100644 --- a/src/RageTexture.cpp +++ b/src/RageTexture.cpp @@ -68,6 +68,7 @@ const RectF *RageTexture::GetTextureCoordRect( int iFrameNo ) const // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the RageTexture. */ class LunaRageTexture: public Luna { public: diff --git a/src/RageTextureRenderTarget.cpp b/src/RageTextureRenderTarget.cpp index 188eaecbde..43881463e9 100644 --- a/src/RageTextureRenderTarget.cpp +++ b/src/RageTextureRenderTarget.cpp @@ -75,6 +75,7 @@ void RageTextureRenderTarget::FinishRenderingTo() // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the RageTextureRenderTarget. */ class LunaRageTextureRenderTarget: public Luna { public: diff --git a/src/RollingNumbers.cpp b/src/RollingNumbers.cpp index 713a175b5e..c211996c56 100644 --- a/src/RollingNumbers.cpp +++ b/src/RollingNumbers.cpp @@ -99,6 +99,7 @@ void RollingNumbers::UpdateText() // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the RollingNumbers. */ class LunaRollingNumbers: public Luna { public: diff --git a/src/ScoreDisplayAliveTime.cpp b/src/ScoreDisplayAliveTime.cpp index 434d093def..0f58b4b992 100644 --- a/src/ScoreDisplayAliveTime.cpp +++ b/src/ScoreDisplayAliveTime.cpp @@ -68,6 +68,7 @@ void ScoreDisplayAliveTime::UpdateNumber() // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the ScoreDisplayAliveTime. */ class LunaScoreDisplayAliveTime: public Luna { public: diff --git a/src/ScoreDisplayCalories.cpp b/src/ScoreDisplayCalories.cpp index 808447f70a..956e289eb9 100644 --- a/src/ScoreDisplayCalories.cpp +++ b/src/ScoreDisplayCalories.cpp @@ -72,6 +72,7 @@ void ScoreDisplayCalories::UpdateNumber() // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the ScoreDisplayCalories. */ class LunaScoreDisplayCalories: public Luna { public: diff --git a/src/Screen.cpp b/src/Screen.cpp index 2993e684d0..325b1abbb1 100644 --- a/src/Screen.cpp +++ b/src/Screen.cpp @@ -279,6 +279,7 @@ void Screen::ClearMessageQueue( const ScreenMessage SM ) // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the Screen. */ class LunaScreen: public Luna { public: diff --git a/src/ScreenAttract.cpp b/src/ScreenAttract.cpp index cd65b9bc3f..6cab04ab6d 100644 --- a/src/ScreenAttract.cpp +++ b/src/ScreenAttract.cpp @@ -165,6 +165,7 @@ void ScreenAttract::GoToStartScreen( RString sScreenName ) // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the ScreenAttract. */ class LunaScreenAttract: public Luna { public: diff --git a/src/ScreenEdit.cpp b/src/ScreenEdit.cpp index 300633546c..a6678f4fb2 100644 --- a/src/ScreenEdit.cpp +++ b/src/ScreenEdit.cpp @@ -4066,6 +4066,7 @@ void ScreenEdit::DoHelp() // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the ScreenEdit. */ class LunaScreenEdit: public Luna { public: diff --git a/src/ScreenEvaluation.cpp b/src/ScreenEvaluation.cpp index ee24a8187c..55333bf14a 100644 --- a/src/ScreenEvaluation.cpp +++ b/src/ScreenEvaluation.cpp @@ -730,6 +730,7 @@ void ScreenEvaluation::HandleMenuStart() // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the ScreenEvaluation. */ class LunaScreenEvaluation: public Luna { public: diff --git a/src/ScreenGameplay.cpp b/src/ScreenGameplay.cpp index a885fc37cb..8ff1bc1896 100644 --- a/src/ScreenGameplay.cpp +++ b/src/ScreenGameplay.cpp @@ -2838,6 +2838,7 @@ bool ScreenGameplay::LoadReplay() // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the ScreenGameplay. */ class LunaScreenGameplay: public Luna { public: @@ -2896,6 +2897,7 @@ public: LUA_REGISTER_DERIVED_CLASS( ScreenGameplay, ScreenWithMenuElements ) +/** @brief Allow Lua to have access to the PlayerInfo. */ class LunaPlayerInfo: public Luna { public: diff --git a/src/ScreenHowToPlay.cpp b/src/ScreenHowToPlay.cpp index e2140ccc4c..44da5dd20c 100644 --- a/src/ScreenHowToPlay.cpp +++ b/src/ScreenHowToPlay.cpp @@ -301,6 +301,7 @@ void ScreenHowToPlay::HandleScreenMessage( const ScreenMessage SM ) // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the ScreenHowToPlay. */ class LunaScreenHowToPlay: public Luna { public: diff --git a/src/ScreenManager.cpp b/src/ScreenManager.cpp index 701b27d574..15dcc3bc32 100644 --- a/src/ScreenManager.cpp +++ b/src/ScreenManager.cpp @@ -866,6 +866,7 @@ void ScreenManager::PlaySharedBackgroundOffCommand() // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the ScreenManager. */ class LunaScreenManager: public Luna { public: diff --git a/src/ScreenNameEntryTraditional.cpp b/src/ScreenNameEntryTraditional.cpp index 453d2eabac..70fdbaf493 100644 --- a/src/ScreenNameEntryTraditional.cpp +++ b/src/ScreenNameEntryTraditional.cpp @@ -238,6 +238,7 @@ bool ScreenNameEntryTraditional::Backspace( PlayerNumber pn ) // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the ScreenNameEntryTraditional. */ class LunaScreenNameEntryTraditional: public Luna { public: diff --git a/src/ScreenNetEvaluation.cpp b/src/ScreenNetEvaluation.cpp index 99199e0d8a..730aaad417 100644 --- a/src/ScreenNetEvaluation.cpp +++ b/src/ScreenNetEvaluation.cpp @@ -226,6 +226,7 @@ void ScreenNetEvaluation::UpdateStats() // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the ScreenNetEvaluation. */ class LunaScreenNetEvaluation: public Luna { public: diff --git a/src/ScreenOptions.cpp b/src/ScreenOptions.cpp index f3f3d71511..e51ad9e232 100644 --- a/src/ScreenOptions.cpp +++ b/src/ScreenOptions.cpp @@ -1277,6 +1277,7 @@ void ScreenOptions::MenuUpDown( const InputEventPlus &input, int iDir ) // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the ScreenOptions. */ class LunaScreenOptions: public Luna { public: diff --git a/src/ScreenPlayerOptions.cpp b/src/ScreenPlayerOptions.cpp index 64fb5a52ee..1ae56fbf0d 100644 --- a/src/ScreenPlayerOptions.cpp +++ b/src/ScreenPlayerOptions.cpp @@ -150,6 +150,7 @@ void ScreenPlayerOptions::UpdateDisqualified( int row, PlayerNumber pn ) // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the ScreenPlayerOptions. */ class LunaScreenPlayerOptions: public Luna { public: diff --git a/src/ScreenProfileLoad.cpp b/src/ScreenProfileLoad.cpp index 41b89f6a0d..6f1cb87cdf 100644 --- a/src/ScreenProfileLoad.cpp +++ b/src/ScreenProfileLoad.cpp @@ -37,6 +37,7 @@ void ScreenProfileLoad::Continue() // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the ScreenProfileLoad. */ class LunaScreenProfileLoad: public Luna { public: diff --git a/src/ScreenProfileSave.cpp b/src/ScreenProfileSave.cpp index 821a55074d..a769f96cd1 100644 --- a/src/ScreenProfileSave.cpp +++ b/src/ScreenProfileSave.cpp @@ -25,6 +25,7 @@ void ScreenProfileSave::Continue() // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the ScreenProfileSave. */ class LunaScreenProfileSave: public Luna { public: diff --git a/src/ScreenPrompt.cpp b/src/ScreenPrompt.cpp index f963c11cd8..efe9bb72e8 100644 --- a/src/ScreenPrompt.cpp +++ b/src/ScreenPrompt.cpp @@ -251,6 +251,8 @@ void ScreenPrompt::TweenOffScreen() // lua start /* #include "LuaBinding.h" + +/** @brief Allow Lua to have access to the ScreenPrompt. class LunaScreenPrompt: public Luna { public: diff --git a/src/ScreenSelectMaster.cpp b/src/ScreenSelectMaster.cpp index 7f775ff215..dd363affa6 100644 --- a/src/ScreenSelectMaster.cpp +++ b/src/ScreenSelectMaster.cpp @@ -942,6 +942,7 @@ float ScreenSelectMaster::GetCursorY( PlayerNumber pn ) // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the ScreenSelectMaster. */ class LunaScreenSelectMaster: public Luna { public: diff --git a/src/ScreenSelectMusic.cpp b/src/ScreenSelectMusic.cpp index f28d6a0396..3fbb770efb 100644 --- a/src/ScreenSelectMusic.cpp +++ b/src/ScreenSelectMusic.cpp @@ -1856,6 +1856,7 @@ void ScreenSelectMusic::AfterMusicChange() // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the ScreenSelectMusic. */ class LunaScreenSelectMusic: public Luna { public: diff --git a/src/ScreenSelectProfile.cpp b/src/ScreenSelectProfile.cpp index cdf1bfd21d..db458d1b57 100644 --- a/src/ScreenSelectProfile.cpp +++ b/src/ScreenSelectProfile.cpp @@ -213,6 +213,7 @@ bool ScreenSelectProfile::Finish(){ // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the ScreenSelectProfile. */ class LunaScreenSelectProfile: public Luna { public: diff --git a/src/ScreenTextEntry.cpp b/src/ScreenTextEntry.cpp index e074d4baa0..cf351429e9 100644 --- a/src/ScreenTextEntry.cpp +++ b/src/ScreenTextEntry.cpp @@ -539,7 +539,7 @@ void ScreenTextEntry::LoadFromTextEntrySettings( const TextEntrySettings &settin BeginScreen(); } -// lua start +/** @brief Allow Lua to have access to the ScreenTextEntry. */ class LunaScreenTextEntry: public Luna { public: diff --git a/src/ScreenWithMenuElements.cpp b/src/ScreenWithMenuElements.cpp index a099df6836..cfee598c48 100644 --- a/src/ScreenWithMenuElements.cpp +++ b/src/ScreenWithMenuElements.cpp @@ -364,7 +364,7 @@ void ScreenWithMenuElementsSimple::MenuBack( const InputEventPlus &input ) // lua start #include "LuaBinding.h" - +/** @brief Allow Lua to have access to the ScreenWithMenuElements. */ class LunaScreenWithMenuElements: public Luna { public: @@ -378,6 +378,7 @@ public: LUA_REGISTER_DERIVED_CLASS( ScreenWithMenuElements, Screen ) +/** @brief Allow Lua to have access to the ScreenWithMenuElementsSimple. */ class LunaScreenWithMenuElementsSimple: public Luna { public: diff --git a/src/Song.cpp b/src/Song.cpp index 0906ee7f6d..7c648aaf8c 100644 --- a/src/Song.cpp +++ b/src/Song.cpp @@ -1457,6 +1457,7 @@ bool Song::IsMarathon() const // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the Song. */ class LunaSong: public Luna { public: diff --git a/src/SongManager.cpp b/src/SongManager.cpp index 7ed727cd74..10e7c2b577 100644 --- a/src/SongManager.cpp +++ b/src/SongManager.cpp @@ -1785,6 +1785,7 @@ int SongManager::GetSongRank(Song* pSong) // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the SongManager. */ class LunaSongManager: public Luna { public: diff --git a/src/Sprite.cpp b/src/Sprite.cpp index eaee5cbf0c..e91aa9bfbd 100644 --- a/src/Sprite.cpp +++ b/src/Sprite.cpp @@ -1084,6 +1084,7 @@ void Sprite::AddImageCoords( float fX, float fY ) // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the Sprite. */ class LunaSprite: public Luna { public: diff --git a/src/StageStats.cpp b/src/StageStats.cpp index b7c5398eb4..131847e188 100644 --- a/src/StageStats.cpp +++ b/src/StageStats.cpp @@ -331,6 +331,7 @@ int StageStats::GetMinimumMissCombo() const // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the StageStats. */ class LunaStageStats: public Luna { public: diff --git a/src/StatsManager.cpp b/src/StatsManager.cpp index 4adb292214..f3cc714ba0 100644 --- a/src/StatsManager.cpp +++ b/src/StatsManager.cpp @@ -345,6 +345,7 @@ void StatsManager::GetStepsInUse( set &apInUseOut ) const // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the StatsManager. */ class LunaStatsManager: public Luna { public: diff --git a/src/StepsDisplay.cpp b/src/StepsDisplay.cpp index 40654ea342..16e4d300ff 100644 --- a/src/StepsDisplay.cpp +++ b/src/StepsDisplay.cpp @@ -267,6 +267,7 @@ void StepsDisplay::SetInternal( const SetParams ¶ms ) // lua start #include "LuaBinding.h" +/** @brief Allow Lua to have access to the StepsDisplay. */ class LunaStepsDisplay: public Luna { public: diff --git a/src/Style.cpp b/src/Style.cpp index b8a41a8dbd..b6b98f6558 100644 --- a/src/Style.cpp +++ b/src/Style.cpp @@ -114,6 +114,7 @@ RString Style::ColToButtonName( int iCol ) const // Lua bindings #include "LuaBinding.h" +/** @brief Allow Lua to have access to the Style. */ class LunaStyle: public Luna