Added some descriptions to documentation so Gtk-doc doesn't complain
authorPhilip Chimento <philip.chimento@gmail.com>
Sat, 1 May 2010 10:21:22 +0000 (10:21 +0000)
committerPhilip Chimento <philip.chimento@gmail.com>
Sat, 1 May 2010 10:21:22 +0000 (10:21 +0000)
git-svn-id: http://lassie.dyndns-server.com/svn/gargoyle-gtk@254 ddfedd41-794f-dd11-ae45-00112f111e67

libchimara/doc.c

index e599ff22d3f928d331ac07ac4dc2cb80bcb9f821..9014870371bfb2931fd505daefb57eea079d67b9 100644 (file)
  * 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.
  */
 
 /**
  * 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.
  */
 
 /**
  * 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.
  */
  
 /**