Edited documentation of ChimaraIF::command signal

The documentation did not mention that the signal can be generated with
the "input" parameter equal to NULL.

diff --git a/libchimara/chimara-if.c b/libchimara/chimara-if.c
index ee91bf9e57e275b61ac1632d83bdadde310911bd..c669804ccbd1f5976c9d07de4eb83f2c1d03c070 100644 (file)
--- a/libchimara/chimara-if.c
+++ b/libchimara/chimara-if.c
@@ -281,12 +281,16 @@ chimara_if_class_init(ChimaraIFClass *klass)
        /**
         * ChimaraIF::command:
         * @self: The widget that received the signal
-        * @input: The command typed into the game
+        * @input: The command typed into the game, or %NULL
         * @response: The game's response to the command
         *
         * 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 confuse this signal.
+        *
+        * It may happen that @input is %NULL, in which case @response is not due to
+        * a user command, but contains the text printed at the beginning of the
+        * game, up until the first prompt.
         */
        chimara_if_signals[COMMAND] = g_signal_new("command",
                G_OBJECT_CLASS_TYPE(klass), 0,