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

[wxWidgets.git] / interface / colordlg.h

diff --git a/interface/colordlg.h b/interface/colordlg.h
index b5df29b264395a2e6d05fef096b58b4c1ebaf928..41233fb1bcdfd3c02ae9f2db87473d4659a4ac16 100644 (file)
--- 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
@@ -15,9 +15,8 @@
     @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
 {
@@ -29,7 +28,7 @@ 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).
-        
+
         @see wxColourData
     */
     wxColourDialog(wxWindow* parent, wxColourData* data = NULL);
@@ -58,29 +57,36 @@ public:
 };
 
 
+
 // ============================================================================
 // 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.
+    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
+        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.
+        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,
                              const wxColour& colInit,
                              const wxString& caption = wxEmptyString,
                              wxColourData* data = NULL);
 
+//@}
+