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

[wxWidgets.git] / interface / region.h

diff --git a/interface/region.h b/interface/region.h
index 834ddb3c6a69071719d9b0150f18835d5c06c156..f27e9db5861f133fb7c56abff1fb1bcf10ae1d31 100644 (file)
--- a/interface/region.h
+++ b/interface/region.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        region.h
-// Purpose:     documentation for wxRegionIterator class
+// Purpose:     interface of wxRegionIterator
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -22,8 +22,7 @@
     @library{wxcore}
     @category{FIXME}
 
-    @seealso
-    wxPaintEvent
+    @see wxPaintEvent
 */
 class wxRegionIterator : public wxObject
 {
@@ -97,6 +96,7 @@ public:
 };
 
 
+
 /**
     @class wxRegion
     @wxheader{region.h}
@@ -111,10 +111,9 @@ public:
     data using the reference counting, are not affected.
 
     @library{wxcore}
-    @category{data}
+    @category{data,gdi}
 
-    @seealso
-    wxRegionIterator
+    @see wxRegionIterator
 */
 class wxRegion : public wxGDIObject
 {
@@ -152,7 +151,7 @@ public:
     /**
         Returns a value indicating whether the given rectangle is contained within the
         region.
-        
+
         @returns The return value is one of wxOutRegion, wxPartRegion and
                  wxInRegion.
     */
@@ -182,9 +181,9 @@ public:
     //@{
     /**
         Finds the intersection of this region and another region.
-        
+
         @returns @true if successful, @false otherwise.
-        
+
         @remarks Creates the intersection of the two regions, that is, the parts
                  which are in both regions. The result is stored in this
                  region.
@@ -211,7 +210,7 @@ public:
     /**
         Moves the region by the specified offsets in horizontal and vertical
         directions.
-        
+
         @returns @true if successful, @false otherwise (the region is unchanged
                  then).
     */
@@ -222,9 +221,9 @@ public:
     //@{
     /**
         Subtracts a region from this region.
-        
+
         @returns @true if successful, @false otherwise.
-        
+
         @remarks This operation combines the parts of 'this' region that are not
                  part of the second region. The result is stored in this
                  region.
@@ -239,9 +238,9 @@ public:
         bitmap. Colour to be treated as transparent is specified in the
         @a transColour argument, along with an
         optional colour tolerance value.
-        
+
         @returns @true if successful, @false otherwise.
-        
+
         @remarks This operation creates a region that combines all of this region
                  and the second region. The result is stored in this
                  region.
@@ -257,9 +256,9 @@ public:
     //@{
     /**
         Finds the Xor of this region and another region.
-        
+
         @returns @true if successful, @false otherwise.
-        
+
         @remarks This operation creates a region that combines all of this region
                  and the second region, except for any overlapping
                  areas. The result is stored in this region.
@@ -274,3 +273,4 @@ public:
     */
     void operator =(const wxRegion& region);
 };
+