Code opschonen, toevoegen documentatie

[projects/chimara/chimara.git] / src / glk.c

diff --git a/src/glk.c b/src/glk.c
index fc22682676d383f7f2aed2be6fdb435b77eeeed9..dbec7596f581f478af528bc8473699e1b1820e5f 100644 (file)
--- a/src/glk.c
+++ b/src/glk.c
@@ -6,8 +6,19 @@
 /**
  * glk_exit:
  * 
- * End the Glk program. As far as the client program is concerned, this
- * function does not return.
+ * Shuts down the Glk program. This function does not return.
+ *
+ * If you print some text to a window and then shut down your program, you can
+ * assume that the player will be able to read it.
+ *
+ * <note><para>
+ *  You should only shut down your program with glk_exit() or by returning from
+ *  your glk_main() function. If you call the ANSI <function>exit()</function> 
+ *  function, bad things may happen. This Glk library is designed for multiple 
+ *  sessions, for example, and you would be cutting off all the sessions instead
+ *  of just yours. You would also prevent final text from being visible to the 
+ *  player.
+ * </para></note>
  */
 void
 glk_exit(void)
@@ -15,12 +26,3 @@ glk_exit(void)
        g_thread_exit(NULL);
 }
 
-/*
-void
-glk_select(event_t *event)
-{
-       gtk_main_iteration();
-}
-*/
-
-