summaryrefslogtreecommitdiff
path: root/src/sound.h
diff options
context:
space:
mode:
authorBjørn Lindeijer <bjorn@lindeijer.nl>2007-09-20 13:24:20 +0000
committerBjørn Lindeijer <bjorn@lindeijer.nl>2007-09-20 13:24:20 +0000
commita84133850af6d348c0c4e252b26618148702153b (patch)
treef4b8d7c9bbdeecd9c1976bdc3d3806909a25cd28 /src/sound.h
parent1afcf2608c0a466d2df21faea1530955cc8061fc (diff)
downloadmana-a84133850af6d348c0c4e252b26618148702153b.tar.gz
mana-a84133850af6d348c0c4e252b26618148702153b.tar.bz2
mana-a84133850af6d348c0c4e252b26618148702153b.tar.xz
mana-a84133850af6d348c0c4e252b26618148702153b.zip
Merged a bunch of small changes from trunk to 0.0 and set svn:eol-style
to native for some files that were still missing this property. This is a feeble attempt to reduce the amount of conflicts for future merges.
Diffstat (limited to 'src/sound.h')
-rw-r--r--src/sound.h18
1 files changed, 9 insertions, 9 deletions
diff --git a/src/sound.h b/src/sound.h
index 07db0587..34490d9a 100644
--- a/src/sound.h
+++ b/src/sound.h
@@ -62,8 +62,8 @@ class Sound {
/**
* Starts background music.
*
- * \param in Full path to file
- * \param loop The number of times the song is played (-1 = infinite)
+ * @param path The full path to the music file.
+ * @param loop The number of times the song is played (-1 = infinite)
*/
void playMusic(const char *path, int loop = -1);
@@ -75,37 +75,37 @@ class Sound {
/**
* Fades in background music.
*
- * \param in Full path to file
- * \param loop The number of times the song is played (-1 = infinite)
- * \param ms Duration of fade-in effect (ms)
+ * @param path The full path to the music file.
+ * @param loop The number of times the song is played (-1 = infinite)
+ * @param ms Duration of fade-in effect (ms)
*/
void fadeInMusic(const char *path, int loop = -1, int ms = 2000);
/**
* Fades out currently running background music track.
*
- * \param ms Duration of fade-out effect (ms)
+ * @param ms Duration of fade-out effect (ms)
*/
void fadeOutMusic(int ms);
/**
* Sets music volume.
*
- * \param volume Volume value
+ * @param volume Volume value
*/
void setMusicVolume(int volume);
/**
* Sets sfx volume.
*
- * \param volume Volume value
+ * @param volume Volume value
*/
void setSfxVolume(int volume);
/**
* Plays an item.
*
- * \param path Full path to file
+ * @param path The resource path to the sound file.
*/
void playSfx(const std::string &path);