Replaced @returns with @return for more standard command use and compatibility.

[wxWidgets.git] / interface / palette.h

diff --git a/interface/palette.h b/interface/palette.h
index 25dbe129307271725710b15876ec1cd86db30ae8..f1a9a4bdc09bb585db2e3411180636ff0767f3c1 100644 (file)
--- a/interface/palette.h
+++ b/interface/palette.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        palette.h
-// Purpose:     documentation for wxPalette class
+// Purpose:     interface of wxPalette
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -27,20 +27,28 @@
     @category{gdi}
 
     @stdobjects
-    Objects:
-    wxNullPalette
+    ::wxNullPalette
 
-    @seealso
-    wxDC::SetPalette, wxBitmap
+    @see wxDC::SetPalette(), wxBitmap
 */
 class wxPalette : public wxGDIObject
 {
 public:
-    //@{
+
+    /**
+        Default constructor.
+    */
+    wxPalette();
+
     /**
-        Creates a palette from arrays of size @e n, one for each
-        red, blue or green component.
-        
+        Copy constructor, uses @ref overview_refcount.
+    */
+    wxPalette(const wxPalette& palette);
+
+    /**
+        Creates a palette from arrays of size @a n, one for each red, blue or
+        green component.
+
         @param palette
             A pointer or reference to the palette to copy.
         @param n
@@ -51,27 +59,24 @@ public:
             An array of green values.
         @param blue
             An array of blue values.
-        
+
         @see Create()
     */
-    wxPalette();
-    wxPalette(const wxPalette& palette);
     wxPalette(int n, const unsigned char* red,
               const unsigned char* green,
               const unsigned char* blue);
-    //@}
 
     /**
         Destructor.
-        See @ref overview_refcountdestruct "reference-counted object destruction" for
-        more info.
+
+        @see @ref overview_refcount_destruct "reference-counted object destruction"
     */
     ~wxPalette();
 
     /**
-        Creates a palette from arrays of size @e n, one for each
-        red, blue or green component.
-        
+        Creates a palette from arrays of size @a n, one for each red, blue or
+        green component.
+
         @param n
             The number of indices in the palette.
         @param red
@@ -80,9 +85,9 @@ public:
             An array of green values.
         @param blue
             An array of blue values.
-        
-        @returns @true if the creation was successful, @false otherwise.
-        
+
+        @return @true if the creation was successful, @false otherwise.
+
         @see wxPalette()
     */
     bool Create(int n, const unsigned char* red,
@@ -92,28 +97,28 @@ public:
     /**
         Returns number of entries in palette.
     */
-    int GetColoursCount();
+    int GetColoursCount() const;
 
     /**
         Returns a pixel value (index into the palette) for the given RGB values.
-        
+
         @param red
             Red value.
         @param green
             Green value.
         @param blue
             Blue value.
-        
-        @returns The nearest palette index or wxNOT_FOUND for unexpected errors.
-        
+
+        @return The nearest palette index or @c wxNOT_FOUND for unexpected errors.
+
         @see GetRGB()
     */
     int GetPixel(unsigned char red, unsigned char green,
-                 unsigned char blue);
+                 unsigned char blue) const;
 
     /**
         Returns RGB values for a given palette index.
-        
+
         @param pixel
             The palette index.
         @param red
@@ -122,22 +127,30 @@ public:
             Receives the green value.
         @param blue
             Receives the blue value.
-        
-        @returns @true if the operation was successful.
-        
+
+        @return @true if the operation was successful.
+
         @see GetPixel()
     */
     bool GetRGB(int pixel, const unsigned char* red,
                 const unsigned char* green,
-                const unsigned char* blue);
+                const unsigned char* blue) const;
 
     /**
         Returns @true if palette data is present.
     */
-    bool IsOk();
+    bool IsOk() const;
 
     /**
-        Assignment operator, using @ref overview_trefcount "reference counting".
+        Assignment operator, using @ref overview_refcount.
     */
-    wxPalette operator =(const wxPalette& palette);
+    wxPalette& operator =(const wxPalette& palette);
 };
+
+
+/**
+    An empty palette.
+*/
+wxPalette wxNullPalette;
+
+