Added draft docs for new functions and gestalt selectors

[projects/chimara/chimara.git] / libchimara / schannel.c

diff --git a/libchimara/schannel.c b/libchimara/schannel.c
index a4935a923278e601f6263618e8ed42128b961181..10057789ed052d556f40e052c6b619c70b97125b 100644 (file)
--- a/libchimara/schannel.c
+++ b/libchimara/schannel.c
@@ -476,11 +476,11 @@ glk_schannel_play_ext(schanid_t chan, glui32 snd, glui32 repeats, glui32 notify)
 
 /**
  * glk_schannel_play_multi:
- * @chanarray:
- * @chancount:
- * @sndarray:
- * @soundcount:
- * @notify:
+ * @chanarray: Array of #schanid_t structures.
+ * @chancount: Length of @chanarray.
+ * @sndarray: Array of sound resource numbers.
+ * @soundcount: Length of @sndarray, must be equal to @chanarray.
+ * @notify: If nonzero, request a notification when each sound finishes.
  * 
  * [DRAFT SPEC]
  *
@@ -675,7 +675,7 @@ glk_schannel_set_volume(schanid_t chan, glui32 vol)
  * volume change should be wherever the previous volume change was interrupted
  * (rather than the previous change's beginning or ending point).
  *
- * Not all libraries support thse functions. You should test the appropriate
+ * Not all libraries support these functions. You should test the appropriate
  * gestalt selectors before you rely on them; see "Testing for Sound
  * Capabilities".
  */