From 081f62701882a4e97b5dff37f51a89965fe9faa5 Mon Sep 17 00:00:00 2001 From: rubidium Date: Sat, 19 Apr 2008 13:05:05 +0000 Subject: (svn r12787) -Documentation: add/fix documentation of some functions. Patch by Alberth. --- src/sound.cpp | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) (limited to 'src/sound.cpp') diff --git a/src/sound.cpp b/src/sound.cpp index c5daccae4..a9c0cb801 100644 --- a/src/sound.cpp +++ b/src/sound.cpp @@ -207,6 +207,14 @@ void SndCopyToPool() } } +/** + * Decide 'where' (between left and right speaker) to play the sound effect. + * @param sound Sound effect to play + * @param left Left edge of virtual coordinates where the sound is produced + * @param right Right edge of virtual coordinates where the sound is produced + * @param top Top edge of virtual coordinates where the sound is produced + * @param bottom Bottom edge of virtual coordinates where the sound is produced + */ static void SndPlayScreenCoordFx(SoundFx sound, int left, int right, int top, int bottom) { Window* const *wz; @@ -231,7 +239,6 @@ static void SndPlayScreenCoordFx(SoundFx sound, int left, int right, int top, in return; } } - } void SndPlayTileFx(SoundFx sound, TileIndex tile) -- cgit v1.2.3-54-g00ecf