X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/23324ae1c7938ba904770fc456d3c07764b9c5e9..7c0d297a1f761de31d3a4ac924fa2080b5bbaf41:/interface/colordlg.h

diff --git a/interface/colordlg.h b/interface/colordlg.h
index cdf5cfae1e..1ed5b25cb8 100644
--- a/interface/colordlg.h
+++ b/interface/colordlg.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        colordlg.h
-// Purpose:     documentation for wxColourDialog class
+// Purpose:     interface of wxColourDialog
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -9,30 +9,31 @@
 /**
     @class wxColourDialog
     @wxheader{colordlg.h}
-    
+
     This class represents the colour chooser dialog.
-    
+
     @library{wxcore}
     @category{cmndlg}
-    
-    @seealso
-    @ref overview_wxcolourdialogoverview "wxColourDialog Overview", wxColour,
-    wxColourData, wxGetColourFromUser
+
+    @see @ref overview_cmndlg_colour, wxColour, wxColourData,
+         wxGetColourFromUser()
 */
 class wxColourDialog : public wxDialog
 {
 public:
     /**
-        Constructor. Pass a parent window, and optionally a pointer to a block of colour
-        data, which will be copied to the colour dialog's colour data. Custom
-        colours from colour data object will be be used in dialog's colour palette.
-        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
+        Constructor. Pass a parent window, and optionally a pointer to a block
+        of colour data, which will be copied to the colour dialog's colour
+        data.
+
+        Custom colours from colour data object will be be used in the dialog's
+        colour palette. 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).
+
+        @see wxColourData
     */
-    wxColourDialog(wxWindow* parent, wxColourData* data = @NULL);
+    wxColourDialog(wxWindow* parent, wxColourData* data = NULL);
 
     /**
         Destructor.
@@ -40,49 +41,53 @@ public:
     ~wxColourDialog();
 
     /**
-        Same as @ref ctor() constructor.
+        Same as wxColourDialog().
     */
-    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
-        dialog.
+        Returns the colour data associated with the colour dialog.
     */
     wxColourData GetColourData();
 
     /**
-        Shows the dialog, returning wxID_OK if the user pressed OK, and wxID_CANCEL
-        otherwise.
+        Shows the dialog, returning wxID_OK if the user pressed OK, and
+        wxID_CANCEL otherwise.
     */
     int ShowModal();
 };
 
 
+
 // ============================================================================
 // 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,
-                             wxColourData * data = @NULL);
+                             wxColourData* data = NULL);
+
+//@}