(svn r18900) -Document: that an empty string for OnQueryTextFinished means 'use default'

1 files changed, 3 insertions, 2 deletions

diff --git a/src/window_gui.h b/src/window_gui.h
index eb2a6ac7f..dccabc09a 100644
--- a/src/window_gui.h
+++ b/src/window_gui.h
@@ -719,8 +719,9 @@ public:
 
 	/**
 	 * The query window opened from this window has closed.
-	 * @param str the new value of the string or NULL if the window
-	 *            was cancelled.
+	 * @param str the new value of the string, NULL if the window
+	 *            was cancelled or an empty string when the default
+	 *            button was pressed, i.e. StrEmpty(str).
 	 */
 	virtual void OnQueryTextFinished(char *str) {}