From 1df183ffcb08a69ed414afd69284a0596fee4e82 Mon Sep 17 00:00:00 2001
From: Paul Gilbert
Date: Tue, 19 May 2015 07:37:55 -0400
Subject: SHERLOCK: Move method comments from cpp to headers

---
 engines/sherlock/sound.h | 42 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)

(limited to 'engines/sherlock/sound.h')

diff --git a/engines/sherlock/sound.h b/engines/sherlock/sound.h
index bff50d7a07..689e615a36 100644
--- a/engines/sherlock/sound.h
+++ b/engines/sherlock/sound.h
@@ -61,19 +61,61 @@ public:
 public:
 	Sound(SherlockEngine *vm, Audio::Mixer *mixer);
 
+	/**
+	 * Saves sound-related settings
+	 */
 	void syncSoundSettings();
+
+	/**
+	 * Load a sound
+	 */
 	void loadSound(const Common::String &name, int priority);
+	
+	/**
+	 * Play the sound in the specified resource
+	 */
 	bool playSound(const Common::String &name, WaitType waitType, int priority = 100, const char *libraryFilename = nullptr);
+	
+	/**
+	 * Play a previously loaded sound
+	 */
 	void playLoadedSound(int bufNum, WaitType waitType);
+	
+	/**
+	 * Free any previously loaded sounds
+	 */
 	void freeLoadedSounds();
+	
+	/**
+	 * Stop playing any active sound
+	 */
 	void stopSound();
 
+	/**
+	 * Load a specified song
+	 */
 	int loadSong(int songNumber);
+
+	/**
+	 * Start playing a song
+	 */
 	void startSong();
+	
+	/**
+	 * Free any currently loaded song
+	 */
 	void freeSong();
 	
+	/**
+	 * Play the specified music resource
+	 */
 	void playMusic(const Common::String &name);
+
+	/**
+	 * Stop playing the music
+	 */
 	void stopMusic();
+	
 	void stopSndFuncPtr(int v1, int v2);
 	void waitTimerRoland(uint time);
 	void freeDigiSound();
-- 
cgit v1.2.3