use wx-style header and commets; fix indentation to be 4 spaces; move Doxygen comment...

[wxWidgets.git] / interface / numdlg.h

diff --git a/interface/numdlg.h b/interface/numdlg.h
index dca6c508340b5c9cfe44ce5555497467fa182b70..904f67e2e8fe9156e58d7a6ddbc9a63c2a29ae72 100644 (file)
--- a/interface/numdlg.h
+++ b/interface/numdlg.h
@@ -1,20 +1,28 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        numdlg.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        numdlg.h

-// Purpose:     documentation for global functions
+// Purpose:     interface of global functions

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // 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,
 */
 long wxGetNumberFromUser(const wxString& message,
                          const wxString& prompt,


@@ -25,4 +33,5 @@ long wxGetNumberFromUser(const wxString& message,
                          wxWindow* parent = NULL,
                          const wxPoint& pos = wxDefaultPosition);
 
                          wxWindow* parent = NULL,
                          const wxPoint& pos = wxDefaultPosition);
 

+//@}