projects
/
projects
/
chimara
/
chimara.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Stop playing old sound when playing new sound
[projects/chimara/chimara.git]
/
libchimara
/
doc.c
diff --git
a/libchimara/doc.c
b/libchimara/doc.c
index e599ff22d3f928d331ac07ac4dc2cb80bcb9f821..df84c6f2d942c95fbb480736578f2b2146464a6b 100644
(file)
--- a/
libchimara/doc.c
+++ b/
libchimara/doc.c
@@
-158,6
+158,7
@@
* Glk through a virtual machine, matters will probably be different. Opaque
* objects may be represented as integers, or as VM objects of some sort.
* </para></note></para>
* Glk through a virtual machine, matters will probably be different. Opaque
* objects may be represented as integers, or as VM objects of some sort.
* </para></note></para>
+ * <para>
* <refsect2 id="chimara-Rocks"><!-- Indeed it does. -->
* <title>Rocks</title>
* <para>
* <refsect2 id="chimara-Rocks"><!-- Indeed it does. -->
* <title>Rocks</title>
* <para>
@@
-1037,18
+1038,26
@@
* SECTION:glk-sound-channels
* @short_description: Creating new sound channels and closing them
* @include: libchimara/glk.h
* SECTION:glk-sound-channels
* @short_description: Creating new sound channels and closing them
* @include: libchimara/glk.h
+ *
+ * Sounds in Glk are played through sound channels. Sound channels are another
+ * type of opaque object, like windows, streams, and file references.
*/
/**
* SECTION:glk-playing-sounds
* @short_description: Producing noise
* @include: libchimara/glk.h
*/
/**
* SECTION:glk-playing-sounds
* @short_description: Producing noise
* @include: libchimara/glk.h
+ *
+ * These functions play the actual sounds through the sound channels.
*/
/**
* SECTION:glk-sound-other
* @short_description: Miscellaneous functions for sound channels
* @include: libchimara/glk.h
*/
/**
* SECTION:glk-sound-other
* @short_description: Miscellaneous functions for sound channels
* @include: libchimara/glk.h
+ *
+ * This section includes functions for sound channels that don't fit anywhere
+ * else.
*/
/**
*/
/**
@@
-1078,6
+1087,9
@@
* SECTION:glk-accepting-hyperlinks
* @short_description: Generating and catching hyperlink navigation events
* @include: libchimara/glk.h
* SECTION:glk-accepting-hyperlinks
* @short_description: Generating and catching hyperlink navigation events
* @include: libchimara/glk.h
+ *
+ * When you request a hyperlink event in a window, you will receive a hyperlink
+ * event when the player clicks on a hyperlink.
*/
/**
*/
/**
@@
-1101,6
+1113,8
@@
* SECTION:dispatch-dispatching
* @short_description: Dispatching the call to the Glk library
* @include: libchimara/glk.h, libchimara/gi_dispa.h
* SECTION:dispatch-dispatching
* @short_description: Dispatching the call to the Glk library
* @include: libchimara/glk.h, libchimara/gi_dispa.h
+ *
+ * The function gidispatch_call() invokes a function from the Glk library.
*/
/**
*/
/**