Added some explanatory documentation to ChimaraGlk and ChimaraIF

[rodin/chimara.git] / libchimara / chimara-if.c

diff --git a/libchimara/chimara-if.c b/libchimara/chimara-if.c
index be9fc206f0c519ec8cd06bbce56e894a02ff63cc..cb0f425f012afd47c5382012ef765b560c901781 100644 (file)
--- a/libchimara/chimara-if.c
+++ b/libchimara/chimara-if.c
@@ -13,11 +13,17 @@
  * SECTION:chimara-if
  * @short_description: Widget which plays an interactive fiction game
  * @stability: Unstable
- * @include: chimara/chimara-if.h
+ * @include: libchimara/chimara-if.h
  *
  * The #ChimaraIF widget, given an interactive fiction game file to run, selects
  * an appropriate interpreter plugin and runs it. Interpreter options are set by
  * setting properties on the widget.
+ *
+ * Using it in a GTK program is similar to using #ChimaraGlk (which see). 
+ * Threads must be initialized before using #ChimaraIF and the call to 
+ * gtk_main() must be bracketed between gdk_threads_enter() and 
+ * gdk_threads_leave(). Use chimara_if_run_game() to start playing an
+ * interactive fiction game.
  */
 
 static gboolean supported_formats[CHIMARA_IF_NUM_FORMATS][CHIMARA_IF_NUM_INTERPRETERS] = {
@@ -279,8 +285,7 @@ chimara_if_class_init(ChimaraIFClass *klass)
         *
         * Emitted once for each input-response cycle of an interactive fiction
         * game. Note that games with nontraditional input systems (i.e. not all
-        * taking place in the same text buffer window) may throw this signal for a
-        * loop.
+        * taking place in the same text buffer window) may confuse this signal.
         */
        chimara_if_signals[COMMAND] = g_signal_new("command",
                G_OBJECT_CLASS_TYPE(klass), 0,