fix various Doxygen errors (#9568)

[wxWidgets.git] / interface / msgdlg.h

diff --git a/interface/msgdlg.h b/interface/msgdlg.h
index c7a88ab7b6f7df24939f6b4c118da108c47c849c..6016e2eed8dfb0d9169363a14abba9b2f8e87b04 100644 (file)
--- a/interface/msgdlg.h
+++ b/interface/msgdlg.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        msgdlg.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        msgdlg.h

-// Purpose:     documentation for wxMessageDialog class
+// Purpose:     interface of wxMessageDialog

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -16,15 +16,14 @@
     @library{wxcore}
     @category{cmndlg}
 
     @library{wxcore}
     @category{cmndlg}
 

-    @seealso
-    @ref overview_wxmessagedialogoverview "wxMessageDialog overview"
+    @see @ref overview_wxmessagedialogoverview "wxMessageDialog overview"

 */
 class wxMessageDialog : public wxDialog
 {
 public:
     /**
         Constructor. Use ShowModal() to show the dialog.
 */
 class wxMessageDialog : public wxDialog
 {
 public:
     /**
         Constructor. Use ShowModal() to show the dialog.

-        
+

         @param parent
             Parent window.
         @param message
         @param parent
             Parent window.
         @param message


@@ -33,129 +32,50 @@ public:
             The dialog caption.
         @param style
             A dialog style (bitlist) containing flags chosen from the following:
             The dialog caption.
         @param style
             A dialog style (bitlist) containing flags chosen from the following:

-        
-        
-        
-        
-        
-        
-        
+

             wxOK
             wxOK

-        
-        
-        
-        
+

             Show an OK button.
             Show an OK button.

-        
-        
-        
-        
-        
+

             wxCANCEL
             wxCANCEL

-        
-        
-        
-        
+

             Show a Cancel button.
             Show a Cancel button.

-        
-        
-        
-        
-        
+

             wxYES_NO
             wxYES_NO

-        
-        
-        
-        
+

             Show Yes and No buttons.
             Show Yes and No buttons.

-        
-        
-        
-        
-        
+

             wxYES_DEFAULT
             wxYES_DEFAULT

-        
-        
-        
-        
+

             Used with wxYES_NO, makes Yes button the default - which is the default
         behaviour.
             Used with wxYES_NO, makes Yes button the default - which is the default
         behaviour.

-        
-        
-        
-        
-        
+

             wxNO_DEFAULT
             wxNO_DEFAULT

-        
-        
-        
-        
+

             Used with wxYES_NO, makes No button the default.
             Used with wxYES_NO, makes No button the default.

-        
-        
-        
-        
-        
+

             wxICON_EXCLAMATION
             wxICON_EXCLAMATION

-        
-        
-        
-        
+

             Shows an exclamation mark icon.
             Shows an exclamation mark icon.

-        
-        
-        
-        
-        
+

             wxICON_HAND
             wxICON_HAND

-        
-        
-        
-        
+

             Shows an error icon.
             Shows an error icon.

-        
-        
-        
-        
-        
+

             wxICON_ERROR
             wxICON_ERROR

-        
-        
-        
-        
+

             Shows an error icon - the same as wxICON_HAND.
             Shows an error icon - the same as wxICON_HAND.

-        
-        
-        
-        
-        
+

             wxICON_QUESTION
             wxICON_QUESTION

-        
-        
-        
-        
+

             Shows a question mark icon.
             Shows a question mark icon.

-        
-        
-        
-        
-        
+

             wxICON_INFORMATION
             wxICON_INFORMATION

-        
-        
-        
-        
+

             Shows an information (i) icon.
             Shows an information (i) icon.

-        
-        
-        
-        
-        
+

             wxSTAY_ON_TOP
             wxSTAY_ON_TOP

-        
-        
-        
-        
+

             The message box stays on top of all other window, even those of the other
         applications (Windows only).
         @param pos
             The message box stays on top of all other window, even those of the other
         applications (Windows only).
         @param pos


@@ -225,62 +145,51 @@ public:
 };
 
 
 };
 
 

+

 // ============================================================================
 // Global functions/macros
 // ============================================================================
 
 // ============================================================================
 // Global functions/macros
 // ============================================================================
 

+/** @ingroup group_funcmacro_dialog */
+//@{
+

 /**
 /**

-    General purpose message dialog.  @a style may be a bit list of the
+    General purpose message dialog. @c style may be a bit list of the

     following identifiers:
 
     following identifiers:
 

-    wxYES_NO
-
-    Puts Yes and No buttons on the message box. May be combined with
-    wxCANCEL.
-
-    wxCANCEL
-
-    Puts a Cancel button on the message box. May only be combined with
-    wxYES_NO or wxOK.
-
-    wxOK
-
-    Puts an Ok button on the message box. May be combined with wxCANCEL.
-
-    wxICON_EXCLAMATION
-
-    Displays an exclamation mark symbol.
-
-    wxICON_HAND
-
-    Displays an error symbol.
-
-    wxICON_ERROR
-
-    Displays an error symbol - the same as wxICON_HAND.
-
-    wxICON_QUESTION
-
-    Displays a question mark symbol.
-
-    wxICON_INFORMATION
-
-    Displays an information symbol.
-
-    The return value is one of: wxYES, wxNO, wxCANCEL, wxOK.
-    For example:
+    @beginStyleTable
+    @style{wxYES_NO}
+        Puts Yes and No buttons on the message box. May be combined with
+        wxCANCEL.
+    @style{wxCANCEL}
+        Puts a Cancel button on the message box. May only be combined with
+        wxYES_NO or wxOK.
+    @style{wxOK}
+        Puts an Ok button on the message box. May be combined with wxCANCEL.
+    @style{wxICON_EXCLAMATION}
+        Displays an exclamation mark symbol.
+    @style{wxICON_HAND}
+        Displays an error symbol.
+    @style{wxICON_ERROR}
+        Displays an error symbol - the same as wxICON_HAND.
+    @style{wxICON_QUESTION}
+        Displays a question mark symbol.
+    @style{wxICON_INFORMATION}
+        Displays an information symbol.
+
+    The return value is one of: wxYES, wxNO, wxCANCEL, wxOK. For example:

 
     @code
 
     @code

-    ...
-      int answer = wxMessageBox("Quit program?", "Confirm",
-                                wxYES_NO | wxCANCEL, main_frame);
-      if (answer == wxYES)
-        main_frame-Close();
-      ...
+    int answer = wxMessageBox("Quit program?", "Confirm",
+                              wxYES_NO | wxCANCEL, main_frame);
+    if (answer == wxYES)
+        main_frame->Close();

     @endcode
 
     @endcode
 

-    @a message may contain newline characters, in which case the
-    message will be split into separate lines, to cater for large messages.
+    @a message may contain newline characters, in which case the message will
+    be split into separate lines, to cater for large messages.
+
+    @header{wx/msgdlg.h}

 */
 int wxMessageBox(const wxString& message,
                  const wxString& caption = "Message",
 */
 int wxMessageBox(const wxString& message,
                  const wxString& caption = "Message",


@@ -288,3 +197,5 @@ int wxMessageBox(const wxString& message,
                  wxWindow* parent = NULL,
                  int x = -1, int y = -1);
 
                  wxWindow* parent = NULL,
                  int x = -1, int y = -1);
 

+//@}
+