From 433c509ad7176d4ff9e0f53828afa9b2aa046d47 Mon Sep 17 00:00:00 2001 From: "P. F. Chimento" Date: Wed, 17 Nov 2010 22:10:13 +0100 Subject: [PATCH] Edited documentation of ChimaraIF::command signal The documentation did not mention that the signal can be generated with the "input" parameter equal to NULL. --- libchimara/chimara-if.c | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/libchimara/chimara-if.c b/libchimara/chimara-if.c index ee91bf9..c669804 100644 --- 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, -- 2.30.2