From: Philip Chimento <philip.chimento@gmail.com>
Date: Mon, 29 Aug 2011 03:52:27 +0000 (-0400)
Subject: Clarify documentation
X-Git-Tag: v0.9~59
X-Git-Url: https://git.stderr.nl/gitweb?p=projects%2Fchimara%2Fchimara.git;a=commitdiff_plain;h=e2c1b09185cc77cdc1245e0c12caab4d7b0e7f6d

Clarify documentation

...of chimara_glk_stop() and chimara_glk_wait()
---

diff --git a/libchimara/chimara-glk.c b/libchimara/chimara-glk.c
index 1a8b224..47c2b51 100644
--- a/libchimara/chimara-glk.c
+++ b/libchimara/chimara-glk.c
@@ -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)