Replaced @returns with @return for more standard command use and compatibility.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@53549 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -155,7 +155,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
|
||||
@return The return value is one of wxOutRegion, wxPartRegion and
|
||||
wxInRegion.
|
||||
*/
|
||||
wxRegionContain Contains(long& x, long& y) const;
|
||||
@@ -185,7 +185,7 @@ public:
|
||||
/**
|
||||
Finds the intersection of this region and another region.
|
||||
|
||||
@returns @true if successful, @false otherwise.
|
||||
@return @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
|
||||
@@ -214,7 +214,7 @@ public:
|
||||
Moves the region by the specified offsets in horizontal and vertical
|
||||
directions.
|
||||
|
||||
@returns @true if successful, @false otherwise (the region is unchanged
|
||||
@return @true if successful, @false otherwise (the region is unchanged
|
||||
then).
|
||||
*/
|
||||
bool Offset(wxCoord x, wxCoord y);
|
||||
@@ -225,7 +225,7 @@ public:
|
||||
/**
|
||||
Subtracts a region from this region.
|
||||
|
||||
@returns @true if successful, @false otherwise.
|
||||
@return @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
|
||||
@@ -242,7 +242,7 @@ public:
|
||||
@a transColour argument, along with an
|
||||
optional colour tolerance value.
|
||||
|
||||
@returns @true if successful, @false otherwise.
|
||||
@return @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
|
||||
@@ -260,7 +260,7 @@ public:
|
||||
/**
|
||||
Finds the Xor of this region and another region.
|
||||
|
||||
@returns @true if successful, @false otherwise.
|
||||
@return @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
|
||||
|
Reference in New Issue
Block a user