]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/numdlg.h
mac paths updated
[wxWidgets.git] / interface / numdlg.h
index 4729b7a7f12688b5ca12f8709cc7531040251d2c..904f67e2e8fe9156e58d7a6ddbc9a63c2a29ae72 100644 (file)
@@ -6,15 +6,23 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
+/** @ingroup group_funcmacro_dialog */
+//@{
+
 /**
-Shows a dialog asking the user for numeric input. The dialogs title is set to
-@e caption, it contains a (possibly) multiline @a message above the
-single line @a prompt and the zone for entering the number.
-The number entered must be in the range @e min..@a max (both of which
-should be positive) and @a value is the initial value of it. If the user
-enters an invalid value or cancels the dialog, the function will return -1.
-Dialog is centered on its @a parent unless an explicit position is given in
-@e pos.
+    Shows a dialog asking the user for numeric input. The dialogs title is set
+    to @c caption, it contains a (possibly) multiline @c message above the
+    single line @c prompt and the zone for entering the number.
+
+    The number entered must be in the range @c min to @c max (both of which
+    should be positive) and @c value is the initial value of it. If the user
+    enters an invalid value or cancels the dialog, the function will return
+    -1.
+
+    Dialog is centered on its @c parent unless an explicit position is given
+    in @c pos.
+
+    @header{wx/numdlg.h}
 */
 long wxGetNumberFromUser(const wxString& message,
                          const wxString& prompt,
@@ -25,4 +33,5 @@ long wxGetNumberFromUser(const wxString& message,
                          wxWindow* parent = NULL,
                          const wxPoint& pos = wxDefaultPosition);
 
+//@}