From: fliep <fliep@ddfedd41-794f-dd11-ae45-00112f111e67>
Date: Sat, 1 May 2010 10:21:22 +0000 (+0000)
Subject: Added some descriptions to documentation so Gtk-doc doesn't complain
X-Git-Tag: v0.9~211
X-Git-Url: https://git.stderr.nl/gitweb?a=commitdiff_plain;h=a9ad53696e40f7b09ccf1bac024e9af2c5835bca;p=projects%2Fchimara%2Fchimara.git

Added some descriptions to documentation so Gtk-doc doesn't complain
---

diff --git a/libchimara/doc.c b/libchimara/doc.c
index e599ff2..9014870 100644
--- a/libchimara/doc.c
+++ b/libchimara/doc.c
@@ -1037,18 +1037,26 @@
  * 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
+ *
+ * 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
+ *
+ * This section includes functions for sound channels that don't fit anywhere
+ * else.
  */
 
 /**
@@ -1078,6 +1086,9 @@
  * 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 +1112,8 @@
  * 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.
  */
  
 /**