Document AudioCDManager::play

svn-id: r25742

1 files changed, 10 insertions, 0 deletions

diff --git a/sound/audiocd.h b/sound/audiocd.h
index b23942c9f5..5b9c05355c 100644
--- a/sound/audiocd.h
+++ b/sound/audiocd.h
@@ -51,6 +51,16 @@ public:
 		int numLoops;
 	};
 
+	/**
+	 * Start playback of the specified "CD" track. This method mimics
+	 * the interface of OSystem::playCD (which it in fact may call, if an Audio CD is
+	 * present), but also can play digital audio tracks in various formats.
+	 *
+	 * @param track			the track to play.
+	 * @param num_loops		how often playback should be repeated (-1 = infinitely often).
+	 * @param start_frame	the frame at which playback should start (75 frames = 1 second).
+	 * @param duration		the number of frames to play (0: play until end)
+	 */
 	void play(int track, int numLoops, int startFrame, int duration);
 	void stop();
 	bool isPlaying() const;