From 3cbf0073529c7bedc3cc946ae85b07826bc225bf Mon Sep 17 00:00:00 2001 From: Jason Felds Date: Sat, 26 Feb 2011 02:54:17 -0500 Subject: [PATCH] Another batch of doxy. --- src/CombinedLifeMeter.h | 23 +++++++++++------ src/CombinedLifeMeterTug.h | 10 ++++---- src/GhostArrowRow.h | 10 ++++---- src/Inventory.h | 11 ++++---- src/NoteDisplay.h | 32 +++++++++++++----------- src/NoteField.h | 10 ++++---- src/NoteSkinManager.h | 10 ++++---- src/ReceptorArrowRow.h | 10 ++++---- src/arch/InputHandler/InputHandler.h | 8 +++--- src/arch/LowLevelWindow/LowLevelWindow.h | 10 ++++---- 10 files changed, 74 insertions(+), 60 deletions(-) diff --git a/src/CombinedLifeMeter.h b/src/CombinedLifeMeter.h index d8a2c778a2..695a7fb800 100644 --- a/src/CombinedLifeMeter.h +++ b/src/CombinedLifeMeter.h @@ -5,7 +5,7 @@ #include "GameConstantsAndTypes.h" #include "ActorFrame.h" - +/** @brief Multiple Players sharing one LifeMeter. */ class CombinedLifeMeter : public ActorFrame { public: @@ -13,11 +13,18 @@ public: virtual ~CombinedLifeMeter() {}; virtual void OnLoadSong() {}; - /* 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. + * + * Note that this *is* called for the head of hold/roll notes. + * @param pn the PlayerNumber that hit the TapNote. + * @param tns the score received from the TapNote. */ virtual void ChangeLife( PlayerNumber pn, TapNoteScore tns ) = 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 pn the PlayerNumber that received the hold note score. + * @param hns the hold note score recently received. + * @param tns the score from the initial TapNote. */ virtual void ChangeLife( PlayerNumber pn, HoldNoteScore hns, TapNoteScore tns ) = 0; virtual void HandleTapScoreNone( PlayerNumber pn ) = 0; }; @@ -26,8 +33,10 @@ public: #endif -/* - * (c) 2003 Chris Danford +/** + * @file + * @author Chris Danford (c) 2003 + * @section LICENSE * All rights reserved. * * Permission is hereby granted, free of charge, to any person obtaining a diff --git a/src/CombinedLifeMeterTug.h b/src/CombinedLifeMeterTug.h index 6f89ef6e4c..c0d295c375 100644 --- a/src/CombinedLifeMeterTug.h +++ b/src/CombinedLifeMeterTug.h @@ -1,12 +1,10 @@ -/* CombinedLifeMeterTug - Dance Magic-like tug-o-war life meter. */ - #ifndef CombinedLifeMeterTug_H #define CombinedLifeMeterTug_H #include "CombinedLifeMeter.h" #include "MeterDisplay.h" - +/** @brief Dance Magic-like tug-o-war life meter. */ class CombinedLifeMeterTug : public CombinedLifeMeter { public: @@ -27,8 +25,10 @@ protected: #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/GhostArrowRow.h b/src/GhostArrowRow.h index 7fdd604343..7d07b66276 100644 --- a/src/GhostArrowRow.h +++ b/src/GhostArrowRow.h @@ -1,5 +1,3 @@ -/* GhostArrowRow - Row of GhostArrow actors. */ - #ifndef GHOSTARROWROW_H #define GHOSTARROWROW_H @@ -8,7 +6,7 @@ #include "NoteTypes.h" class PlayerState; - +/** @brief Row of GhostArrow Actors. */ class GhostArrowRow : public ActorFrame { public: @@ -34,8 +32,10 @@ protected: #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/Inventory.h b/src/Inventory.h index f3446da2ac..1571997cbb 100644 --- a/src/Inventory.h +++ b/src/Inventory.h @@ -1,5 +1,3 @@ -/* Inventory - Inventory management for PLAY_MODE_BATTLE. */ - #ifndef Inventory_H #define Inventory_H @@ -13,7 +11,7 @@ AutoScreenMessage( SM_BattleDamageLevel2 ); AutoScreenMessage( SM_BattleDamageLevel3 ); class PlayerState; - +/** @brief Inventory management for PLAY_MODE_BATTLE. */ class Inventory : public Actor { public: @@ -32,6 +30,7 @@ protected: PlayerState* m_pPlayerState; int m_iLastSeenCombo; + /** @brief a sound played when an item has been acquired. */ RageSound m_soundAcquireItem; vector m_vpSoundUseItem; RageSound m_soundItemEnding; @@ -39,8 +38,10 @@ protected: #endif -/* - * (c) 2003 Chris Danford +/** + * @file + * @author Chris Danford (c) 2003 + * @section LICENSE * All rights reserved. * * Permission is hereby granted, free of charge, to any person obtaining a diff --git a/src/NoteDisplay.h b/src/NoteDisplay.h index 0f1d938798..b18431404c 100644 --- a/src/NoteDisplay.h +++ b/src/NoteDisplay.h @@ -8,18 +8,18 @@ class PlayerState; struct TapNote; struct HoldNoteResult; struct NoteMetricCache_t; - +/** @brief the various parts of a Note. */ enum NotePart { - NotePart_Tap, - NotePart_Mine, - NotePart_Lift, - NotePart_Fake, - NotePart_HoldHead, - NotePart_HoldTail, - NotePart_HoldTopCap, - NotePart_HoldBody, - NotePart_HoldBottomCap, + NotePart_Tap, /**< The part representing a traditional TapNote. */ + NotePart_Mine, /**< The part representing a mine. */ + NotePart_Lift, /**< The part representing a lift note. */ + NotePart_Fake, /**< The part representing a fake note. */ + NotePart_HoldHead, /**< The part representing a hold head. */ + NotePart_HoldTail, /**< The part representing a hold tail. */ + NotePart_HoldTopCap, /**< The part representing a hold's top cap. */ + NotePart_HoldBody, /**< The part representing a hold's body. */ + NotePart_HoldBottomCap, /**< The part representing a hold's bottom cap. */ NUM_NotePart, NotePart_Invalid }; @@ -45,11 +45,11 @@ struct NoteColorSprite private: NoteResource *m_p; }; - +/** @brief What types of holds are there? */ enum HoldType { - hold, - roll, + hold, /**< Merely keep your foot held on the body for it to count. */ + roll, /**< Keep hitting the hold body for it to stay alive. */ // minefield, NUM_HoldType, HoldType_Invalid @@ -120,8 +120,10 @@ private: #endif -/* - * (c) 2001-2006 Brian Bugh, Ben Nordstrom, Chris Danford, Steve Checkoway +/** + * @file + * @author Brian Bugh, Ben Nordstrom, Chris Danford, Steve Checkoway (c) 2001-2006 + * @section LICENSE * All rights reserved. * * Permission is hereby granted, free of charge, to any person obtaining a diff --git a/src/NoteField.h b/src/NoteField.h index eb4d3b0645..4a9723288f 100644 --- a/src/NoteField.h +++ b/src/NoteField.h @@ -1,5 +1,3 @@ -/* NoteField - An Actor that renders a NoteData. */ - #ifndef NOTE_FIELD_H #define NOTE_FIELD_H @@ -13,7 +11,7 @@ struct Attack; class NoteData; - +/** @brief An Actor that renders NoteData. */ class NoteField : public ActorFrame { public: @@ -103,8 +101,10 @@ protected: #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/NoteSkinManager.h b/src/NoteSkinManager.h index 42b94c9457..32cbd0781b 100644 --- a/src/NoteSkinManager.h +++ b/src/NoteSkinManager.h @@ -1,5 +1,3 @@ -/* NoteSkinManager - Loads note skins. */ - #ifndef NOTE_SKIN_MANAGER_H #define NOTE_SKIN_MANAGER_H @@ -10,7 +8,7 @@ class Game; struct NoteSkinData; - +/** @brief Loads note skins. */ class NoteSkinManager { public: @@ -63,8 +61,10 @@ public: #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/ReceptorArrowRow.h b/src/ReceptorArrowRow.h index 3cf7e46ed1..957ca2f8ac 100644 --- a/src/ReceptorArrowRow.h +++ b/src/ReceptorArrowRow.h @@ -1,5 +1,3 @@ -/* ReceptorArrowRow - A row of ReceptorArrow objects. */ - #ifndef RECEPTOR_ARROW_ROW_H #define RECEPTOR_ARROW_ROW_H @@ -8,7 +6,7 @@ #include "GameConstantsAndTypes.h" class PlayerState; - +/** @brief A row of ReceptorArrow objects. */ class ReceptorArrowRow : public ActorFrame { public: @@ -35,8 +33,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/arch/InputHandler/InputHandler.h b/src/arch/InputHandler/InputHandler.h index 4282ffddd1..5bb41914e3 100644 --- a/src/arch/InputHandler/InputHandler.h +++ b/src/arch/InputHandler/InputHandler.h @@ -18,7 +18,7 @@ * if it becomes needed.) */ #include "RageInputDevice.h" // for InputDevice #include "arch/RageDriver.h" - +/** @brief A class designed to handle special input devices. */ class InputHandler: public RageDriver { public: @@ -75,8 +75,10 @@ private: #endif -/* - * (c) 2003-2004 Glenn Maynard +/** + * @file + * @author Glenn Maynard (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/LowLevelWindow/LowLevelWindow.h b/src/arch/LowLevelWindow/LowLevelWindow.h index a1815aefe9..631d2b3f6c 100644 --- a/src/arch/LowLevelWindow/LowLevelWindow.h +++ b/src/arch/LowLevelWindow/LowLevelWindow.h @@ -1,8 +1,6 @@ #ifndef LOW_LEVEL_WINDOW_H #define LOW_LEVEL_WINDOW_H -/* This handles low-level operations that OGL 1.x doesn't give us. */ - #include class DisplayResolution; @@ -10,7 +8,7 @@ typedef set DisplayResolutions; class VideoModeParams; class RenderTarget; struct RenderTargetParam; - +/** @brief Handle low-level operations that OGL 1.x doesn't give us. */ class LowLevelWindow { public: @@ -46,8 +44,10 @@ public: #endif -/* - * (c) 2003-2004 Glenn Maynard +/** + * @file + * @author Glenn Maynard (c) 2003-2004 + * @section LICENSE * All rights reserved. * * Permission is hereby granted, free of charge, to any person obtaining a