Fix http://bugzilla.lyx.org/show_bug.cgi?id=5430 .

[features.git] / src / frontends / alert.h

diff --git a/src/frontends/alert.h b/src/frontends/alert.h
index 004a17988578e52b04118e91dcfb25ed32883a41..b4e123731c0878cfb4d303578fbf20bb1c2a422d 100644 (file)
--- a/src/frontends/alert.h
+++ b/src/frontends/alert.h
@@ -54,7 +54,10 @@ void error(docstring const & title, docstring const & message);
  */
 void information(docstring const & title, docstring const & message);
 
-/// Asks for a text. DO NOT USE !!
+/**
+ * Asks for a text. Returns true for OK. Obtained message is in response
+ * (even empty string). dflt stands for default message in the dialog.
+ */
 bool askForText(docstring & response, docstring const & msg,
        docstring const & dflt = docstring());