Clarify documentation
authorPhilip Chimento <philip.chimento@gmail.com>
Mon, 29 Aug 2011 03:52:27 +0000 (23:52 -0400)
committerPhilip Chimento <philip.chimento@gmail.com>
Mon, 29 Aug 2011 03:52:27 +0000 (23:52 -0400)
...of chimara_glk_stop() and chimara_glk_wait()

libchimara/chimara-glk.c

index 1a8b2245143f22e725d4747a8c9aaf26d0f0bf7f..47c2b51b014b320d625bfabc3cf1147d004902af 100644 (file)
@@ -1307,6 +1307,8 @@ chimara_glk_run(ChimaraGlk *glk, const gchar *plugin, int argc, char *argv[], GE
  * Signals the Glk program running in @glk to abort. Note that if the program is
  * caught in an infinite loop in which glk_tick() is not called, this may not
  * work.
+ *
+ * This function does nothing if no Glk program is running.
  */
 void
 chimara_glk_stop(ChimaraGlk *glk)
@@ -1337,6 +1339,8 @@ chimara_glk_stop(ChimaraGlk *glk)
  *
  * Holds up the main thread and waits for the Glk program running in @glk to 
  * finish.
+ *
+ * This function does nothing if no Glk program is running.
  */
 void
 chimara_glk_wait(ChimaraGlk *glk)