From 0e8b4b8371756a4c314d69a26d6e4a07ec6bb009 Mon Sep 17 00:00:00 2001 From: Glenn Maynard Date: Sun, 13 Feb 2005 03:21:22 +0000 Subject: [PATCH] comments, cleanup --- stepmania/src/RageFile.h | 4 +-- stepmania/src/RageFileDriver.h | 2 +- stepmania/src/RageFileDriverTimeout.h | 2 +- stepmania/src/RageFileDriverZip.h | 4 ++- stepmania/src/RageFileManager.h | 4 +-- stepmania/src/RageInput.h | 7 +++-- stepmania/src/RageInputDevice.h | 5 ++-- stepmania/src/RageLog.h | 4 +-- stepmania/src/RageModelGeometry.h | 6 ++-- stepmania/src/RageSoundManager.h | 40 ++++++++++++++------------- 10 files changed, 38 insertions(+), 40 deletions(-) diff --git a/stepmania/src/RageFile.h b/stepmania/src/RageFile.h index 365e2fe47c..7553eb41e6 100644 --- a/stepmania/src/RageFile.h +++ b/stepmania/src/RageFile.h @@ -1,6 +1,4 @@ -/* - * RageFile: high-level file abstraction - */ +/* RageFile - High-level file access. */ #ifndef RAGE_FILE_H #define RAGE_FILE_H diff --git a/stepmania/src/RageFileDriver.h b/stepmania/src/RageFileDriver.h index 9995a72ca6..8105970f7f 100644 --- a/stepmania/src/RageFileDriver.h +++ b/stepmania/src/RageFileDriver.h @@ -1,4 +1,4 @@ -/* RageFileDriver, RageFileObj: Low-level file access driver classes. */ +/* RageFileDriver - File driver base classes. */ #ifndef RAGE_FILE_DRIVER_H #define RAGE_FILE_DRIVER_H diff --git a/stepmania/src/RageFileDriverTimeout.h b/stepmania/src/RageFileDriverTimeout.h index e05866d5d3..983d82240c 100644 --- a/stepmania/src/RageFileDriverTimeout.h +++ b/stepmania/src/RageFileDriverTimeout.h @@ -1,4 +1,4 @@ -/* RageFileDriverTimeOut - manipulate files with a forced timeout */ +/* RageFileDriverTimeOut - manipulate files with a forced timeout. */ #ifndef RAGE_FILE_DRIVER_TIMEOUT_H #define RAGE_FILE_DRIVER_TIMEOUT_H diff --git a/stepmania/src/RageFileDriverZip.h b/stepmania/src/RageFileDriverZip.h index 6e25609f4d..ac00d9a2d7 100644 --- a/stepmania/src/RageFileDriverZip.h +++ b/stepmania/src/RageFileDriverZip.h @@ -1,3 +1,5 @@ +/* RageFileDriverZip - A read-only file driver for ZIPs. */ + #ifndef RAGE_FILE_DRIVER_ZIP_H #define RAGE_FILE_DRIVER_ZIP_H @@ -16,7 +18,7 @@ public: private: RageFile zip; - vector Files; + vector Files; void ParseZipfile(); static void ReadEndCentralRecord( RageFile &zip, end_central_dir_record &ec ); diff --git a/stepmania/src/RageFileManager.h b/stepmania/src/RageFileManager.h index 6b778299e6..8318b9022d 100644 --- a/stepmania/src/RageFileManager.h +++ b/stepmania/src/RageFileManager.h @@ -1,6 +1,4 @@ -/* - * RageFileManager: File utilities and high-level manager for RageFile objects. - */ +/* RageFileManager - File utilities and high-level manager for RageFile objects. */ #ifndef RAGE_FILE_MANAGER_H #define RAGE_FILE_MANAGER_H diff --git a/stepmania/src/RageInput.h b/stepmania/src/RageInput.h index a3f29639dd..20ae1aa735 100644 --- a/stepmania/src/RageInput.h +++ b/stepmania/src/RageInput.h @@ -1,4 +1,4 @@ -/* RageInput: Starts up InputHandlers, which generate InputEvents. */ +/* RageInput - Starts up InputHandlers, which generate InputEvents. */ #ifndef RAGEINPUT_H #define RAGEINPUT_H @@ -8,8 +8,6 @@ class InputHandler; class RageInput { - vector Devices; - public: RageInput( CString drivers ); ~RageInput(); @@ -17,6 +15,9 @@ public: void Update( float fDeltaTime ); void GetDevicesAndDescriptions(vector& vDevicesOut, vector& vDescriptionsOut); void WindowReset(); + +private: + vector Devices; }; extern RageInput* INPUTMAN; // global and accessable from anywhere in our program diff --git a/stepmania/src/RageInputDevice.h b/stepmania/src/RageInputDevice.h index e59bd4a38a..4a3503b93a 100644 --- a/stepmania/src/RageInputDevice.h +++ b/stepmania/src/RageInputDevice.h @@ -1,5 +1,6 @@ -#ifndef RAGEINPUTDEVICE_H -#define RAGEINPUTDEVICE_H 1 +/* RageInputDevice - User input types. */ +#ifndef RAGE_INPUT_DEVICE_H +#define RAGE_INPUT_DEVICE_H #include "RageTimer.h" diff --git a/stepmania/src/RageLog.h b/stepmania/src/RageLog.h index 3514595fc8..606b86ae0e 100644 --- a/stepmania/src/RageLog.h +++ b/stepmania/src/RageLog.h @@ -1,6 +1,4 @@ -/* - * RageLog - Manages logging. - */ +/* RageLog - Manages logging. */ #ifndef RAGELOG_H #define RAGELOG_H diff --git a/stepmania/src/RageModelGeometry.h b/stepmania/src/RageModelGeometry.h index 387e2fb1e6..561c18808b 100644 --- a/stepmania/src/RageModelGeometry.h +++ b/stepmania/src/RageModelGeometry.h @@ -1,6 +1,4 @@ -/* - * RageModelGeometry - stores model geometry - */ +/* RageModelGeometry - Stores mesh data. */ #ifndef RAGE_MODEL_GEOMETRY_H #define RAGE_MODEL_GEOMETRY_H @@ -24,7 +22,7 @@ public: int m_iRefCount; vector m_Meshes; - RageCompiledGeometry* m_pCompiledGeometry; // video memory copy of geometry shared by all meshes + RageCompiledGeometry* m_pCompiledGeometry; // video memory copy of geometry shared by all meshes RageVector3 m_vMins, m_vMaxs; }; diff --git a/stepmania/src/RageSoundManager.h b/stepmania/src/RageSoundManager.h index e38fb125ab..487f467137 100644 --- a/stepmania/src/RageSoundManager.h +++ b/stepmania/src/RageSoundManager.h @@ -1,3 +1,5 @@ +/* RageSoundManager - A global singleton to interface RageSound and RageSoundDriver. */ + #ifndef RAGE_SOUND_MANAGER_H #define RAGE_SOUND_MANAGER_H @@ -12,25 +14,6 @@ struct RageSoundParams; class RageSoundManager { - /* Set of sounds that we've taken over (and are responsible for deleting - * when they're finished playing): */ - set owned_sounds; - - /* A list of all sounds that currently exist, by ID. */ - map all_sounds; - - RageSoundDriver *driver; - - /* Prefs: */ - float MixVolume; - struct queued_pos_map_t - { - int ID, pos, got_frames; - int64_t frameno; - }; - - CircBuf pos_map_queue; - public: RageSoundManager(); ~RageSoundManager(); @@ -70,7 +53,26 @@ public: static void AttenuateBuf( int16_t *buf, int samples, float vol ); private: + /* Set of sounds that we've taken over (and are responsible for deleting + * when they're finished playing): */ + set owned_sounds; + + /* A list of all sounds that currently exist, by ID. */ + map all_sounds; + + RageSoundDriver *driver; + + /* Prefs: */ + float MixVolume; + struct queued_pos_map_t + { + int ID, pos, got_frames; + int64_t frameno; + }; + + CircBuf pos_map_queue; void FlushPosMapQueue(); + RageSound *GetSoundByID( int ID ); };