Minor clarification

[wxWidgets.git] / interface / quantize.h

diff --git a/interface/quantize.h b/interface/quantize.h
index 6089cd2324a587a78b55d283c587563f7cdfeabe..4ba79d58a74eaa687b3b7f42ca81fcdd675487e9 100644 (file)
--- a/interface/quantize.h
+++ b/interface/quantize.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        quantize.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        quantize.h

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

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


@@ -9,12 +9,12 @@
 /**
     @class wxQuantize
     @wxheader{quantize.h}
 /**
     @class wxQuantize
     @wxheader{quantize.h}

-    
+

     Performs quantization, or colour reduction, on a wxImage.
     Performs quantization, or colour reduction, on a wxImage.

-    
+

     Functions in this class are static and so a wxQuantize object need not be
     created.
     Functions in this class are static and so a wxQuantize object need not be
     created.

-    
+

     @library{wxcore}
     @category{misc}
 */
     @library{wxcore}
     @category{misc}
 */


@@ -29,10 +29,8 @@ public:
 
     /**
         Converts input bitmap(s) into 8bit representation with custom palette.
 
     /**
         Converts input bitmap(s) into 8bit representation with custom palette.

-        

         in_rows and out_rows are arrays [0..h-1] of pointer to rows
         (in_rows contains w * 3 bytes per row, out_rows w bytes per row).
         in_rows and out_rows are arrays [0..h-1] of pointer to rows
         (in_rows contains w * 3 bytes per row, out_rows w bytes per row).

-        

         Fills out_rows with indexes into palette (which is also stored into palette
         variable).
     */
         Fills out_rows with indexes into palette (which is also stored into palette
         variable).
     */


@@ -51,9 +49,10 @@ public:
                   int desiredNoColours = 236,
                   unsigned char** eightBitData = 0,
                   int flags = wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE|wxQUANTIZE_RETURN_8BIT_DATA);
                   int desiredNoColours = 236,
                   unsigned char** eightBitData = 0,
                   int flags = wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE|wxQUANTIZE_RETURN_8BIT_DATA);

-        bool Quantize(const wxImage& src, wxImage& dest,
-                      int desiredNoColours = 236,
-                      unsigned char** eightBitData = 0,
-                      int flags = wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE|wxQUANTIZE_RETURN_8BIT_DATA);
+    bool Quantize(const wxImage& src, wxImage& dest,
+                  int desiredNoColours = 236,
+                  unsigned char** eightBitData = 0,
+                  int flags = wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE|wxQUANTIZE_RETURN_8BIT_DATA);

     //@}
 };
     //@}
 };

+