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

[rodin/chimara.git] / libchimara / doc.c

diff --git a/libchimara/doc.c b/libchimara/doc.c
index 3fd18ca0f55778eb8c719b9a28fc5bcc2bd337b8..9014870371bfb2931fd505daefb57eea079d67b9 100644 (file)
--- 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.
  */
  
 /**
@@ -1229,6 +1242,23 @@
  * generally be limited to finding and opening data files. There are a few Unix
  * Glk library functions which are convenient for this purpose.
  */
+
+/**
+ * SECTION:glkext-garglk
+ * @short_description: Gargoyle extensions to Glk
+ * @include: libchimara/glk.h, libchimara/garglk.h
+ *
+ * This section describes various extensions to Glk that were written for the
+ * popular interpreter <ulink 
+ * url="http://www.ccxvii.net/gargoyle/">Gargoyle</ulink> by Tor Andersson (now 
+ * maintained by Ben Cressey).
+ *
+ * These functions mostly serve to close the gap between Glk's input/output
+ * capabilities and what some interpreters expect. For example, 
+ * garglk_set_zcolors() displays the colors defined in the Z-machine standard,
+ * and garglk_set_story_name() can be used to give the host program a hint
+ * about what to display in the title bar of its window.
+ */ 
  
 /*---------------- TYPES AND CONSTANTS FROM GLK.H ----------------------------*/