Changeset 298:24c67ec5cdca for src/mlx/sound.py

Timestamp:

07/21/12 12:43:34 (12 years ago)

Author:

István Váradi <ivaradi@…>

Branch:

default

hg-Phase:

(<MercurialRepository 1 'hg:/home/ivaradi/mlx/hg' '/'>, 'public')

Message:

Documented the non-GUI modules

File:

• src/mlx/sound.py (modified) (1 diff)

src/mlx/sound.py

@@ -1 @@
-# Module to handle sound playback
-
-#------------------------------------------------------------------------------
 
 import os
 import traceback
+
+#------------------------------------------------------------------------------
+
+## @package mlx.sound
+#
+# Sound playback handling.
+#
+# This is the low level sound playback handling. The \ref initializeSound
+# function should be called to initialize the sound handling with the directory
+# containing the sound files. Then the \startSound function should be called to
+# start the playback of a certain sound file. A callback may be called when the
+# playback of a certain file has finished.
+#
+# See also the \ref mlx.soundsched module.
 
 #------------------------------------------------------------------------------