X-Git-Url: https://git.stderr.nl/gitweb?a=blobdiff_plain;f=libchimara%2Fchimara-if.c;h=cb0f425f012afd47c5382012ef765b560c901781;hb=b82a2337120f77f26cf3528a78ce64e55390a23f;hp=7b91830acdce059d12ab64193a28355cbf6c75df;hpb=2232dafd1293635e1c22fa4f2a763f9389ec61d2;p=projects%2Fchimara%2Fchimara.git

diff --git a/libchimara/chimara-if.c b/libchimara/chimara-if.c
index 7b91830..cb0f425 100644
--- 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] = {