Send build notification to wx-buildbot mailing list.

[wxWidgets.git] / interface / colordlg.h

diff --git a/interface/colordlg.h b/interface/colordlg.h
index cdf5cfae1eff549e66c819f657ea85ed28fd3c2c..41233fb1bcdfd3c02ae9f2db87473d4659a4ac16 100644 (file)
--- a/interface/colordlg.h
+++ b/interface/colordlg.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        colordlg.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        colordlg.h

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

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


@@ -9,15 +9,14 @@
 /**
     @class wxColourDialog
     @wxheader{colordlg.h}
 /**
     @class wxColourDialog
     @wxheader{colordlg.h}

-    
+

     This class represents the colour chooser dialog.
     This class represents the colour chooser dialog.

-    
+

     @library{wxcore}
     @category{cmndlg}
     @library{wxcore}
     @category{cmndlg}

-    
-    @seealso
-    @ref overview_wxcolourdialogoverview "wxColourDialog Overview", wxColour,
-    wxColourData, wxGetColourFromUser
+
+    @see @ref overview_wxcolourdialogoverview "wxColourDialog Overview", wxColour,
+    wxColourData, wxGetColourFromUser()

 */
 class wxColourDialog : public wxDialog
 {
 */
 class wxColourDialog : public wxDialog
 {


@@ -29,10 +28,10 @@ public:
         Invalid entries in custom colours list will be ignored on some platforms (GTK)
         or replaced with white colour on platforms where custom colours palette has
         fixed size (MSW).
         Invalid entries in custom colours list will be ignored on some platforms (GTK)
         or replaced with white colour on platforms where custom colours palette has
         fixed size (MSW).

-        
-        @sa wxColourData
+
+        @see wxColourData

     */
     */

-    wxColourDialog(wxWindow* parent, wxColourData* data = @NULL);
+    wxColourDialog(wxWindow* parent, wxColourData* data = NULL);

 
     /**
         Destructor.
 
     /**
         Destructor.


@@ -42,7 +41,7 @@ public:
     /**
         Same as @ref ctor() constructor.
     */
     /**
         Same as @ref ctor() constructor.
     */

-    bool Create(wxWindow* parent, wxColourData* data = @NULL);
+    bool Create(wxWindow* parent, wxColourData* data = NULL);

 
     /**
         Returns the @ref overview_wxcolourdata "colour data" associated with the colour
 
     /**
         Returns the @ref overview_wxcolourdata "colour data" associated with the colour


@@ -58,31 +57,36 @@ public:
 };
 
 
 };
 
 

+

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

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

 /**
 /**

-    Shows the colour selection dialog and returns the colour selected by user or
-    invalid colour (use @ref wxColour::isok wxColour:IsOk to test whether a colour
-    is valid) if the dialog was cancelled.
-    
-    @param parent 
-    The parent window for the colour selection dialog
-    
-    @param colInit 
-    If given, this will be the colour initially selected in the dialog.
-    
-    @param caption 
-    If given, this will be used for the dialog caption.
-    
-    @param data 
-    Optional object storing additional colour dialog settings, such
-    as custom colours. If none is provided the same settings as the last time are
-    used.
+    Shows the colour selection dialog and returns the colour selected by user
+    or invalid colour (use wxColour::IsOk() to test whether a colour is valid)
+    if the dialog was cancelled.
+
+    @param parent
+        The parent window for the colour selection dialog.
+    @param colInit
+        If given, this will be the colour initially selected in the dialog.
+    @param caption
+        If given, this will be used for the dialog caption.
+    @param data
+        Optional object storing additional colour dialog settings, such as
+        custom colours. If none is provided the same settings as the last time
+        are used.
+
+    @header{wx/colordlg.h}

 */
 */

-wxColour wxGetColourFromUser(wxWindow * parent,
+wxColour wxGetColourFromUser(wxWindow* parent,

                              const wxColour& colInit,
                              const wxString& caption = wxEmptyString,
                              const wxColour& colInit,
                              const wxString& caption = wxEmptyString,

-                             wxColourData * data = @NULL);
+                             wxColourData* data = NULL);
+
+//@}