X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/40fcf546f6168f51c070d4ded3c40a75c0780fe8..939fdcf6b767cd8beec43c46e43f576fed530e1a:/interface/wx/gdicmn.h

diff --git a/interface/wx/gdicmn.h b/interface/wx/gdicmn.h
index fb9d647fab..fb5089f714 100644
--- a/interface/wx/gdicmn.h
+++ b/interface/wx/gdicmn.h
@@ -311,14 +311,19 @@ public:
     wxRect Inflate(wxCoord dx, wxCoord dy) const;
     //@}
 
-    //@{
     /**
-        Modifies the rectangle to contain the overlapping box of this rectangle
+        Modifies this rectangle to contain the overlapping portion of this rectangle
         and the one passed in as parameter.
+
+        @return This rectangle, modified.
     */
-    wxRect Intersect(const wxRect& rect) const;
     wxRect& Intersect(const wxRect& rect);
-    //@}
+
+    /**
+        Returns the overlapping portion of this rectangle and the one passed in as
+        parameter.
+    */
+    wxRect Intersect(const wxRect& rect) const;
 
     /**
         Returns @true if this rectangle has a non-empty intersection with the
@@ -402,7 +407,7 @@ public:
     /**
         Assignment operator.
     */
-    void operator =(const wxRect& rect);
+    wxRect& operator=(const wxRect& rect);
 
     /**
         Equality operator.
@@ -462,7 +467,7 @@ public:
     /**
         Assignment operator.
     */
-    void operator =(const wxPoint& pt);
+    wxPoint& operator=(const wxPoint& pt);
 
     bool operator ==(const wxPoint& p1, const wxPoint& p2);
     bool operator !=(const wxPoint& p1, const wxPoint& p2);
@@ -612,7 +617,7 @@ public:
         is, wxColour::IsOk() will return @false) if the colour wasn't found in
         the database.
     */
-    wxColour Find(const wxString& colourName);
+    wxColour Find(const wxString& colourName) const;
 
     /**
         Finds a colour name given the colour. Returns an empty string if the
@@ -757,7 +762,7 @@ public:
     /**
         Assignment operator.
     */
-    void operator =(const wxSize& sz);
+    wxSize& operator=(const wxSize& sz);
 
     bool operator ==(const wxSize& s1, const wxSize& s2);
     bool operator !=(const wxSize& s1, const wxSize& s2);
@@ -786,7 +791,7 @@ wxSize wxDefaultSize;
 // Global functions/macros
 // ============================================================================
 
-/** @ingroup group_funcmacro_gdi */
+/** @addtogroup group_funcmacro_gdi */
 //@{
 
 /**
@@ -838,7 +843,7 @@ void wxSetCursor(const wxCursor& cursor);
 
 //@}
 
-/** @ingroup group_funcmacro_gdi */
+/** @addtogroup group_funcmacro_gdi */
 //@{
 /**
     Returns the dimensions of the work area on the display. On Windows this
@@ -852,11 +857,14 @@ void wxClientDisplayRect(int* x, int* y, int* width, int* height);
 wxRect wxGetClientDisplayRect();
 //@}
 
-/** @ingroup group_funcmacro_gdi */
+/** @addtogroup group_funcmacro_gdi */
 //@{
 /**
     Returns the display resolution in pixels per inch.
 
+    The @c x component of the returned wxSize object contains the horizontal
+    resolution and the @c y one -- the vertical resolution.
+
     @header{wx/gdicmn.h}
 
     @since 2.9.0
@@ -864,22 +872,30 @@ wxRect wxGetClientDisplayRect();
 wxSize wxGetDisplayPPI();
 //@}
 
-/** @ingroup group_funcmacro_gdi */
+/** @addtogroup group_funcmacro_gdi */
 //@{
 /**
     Returns the display size in pixels.
 
+    For the version taking @a width and @a header arguments, either of them
+    can be @NULL if the caller is not interested in the returned value.
+
     @header{wx/gdicmn.h}
 */
 void wxDisplaySize(int* width, int* height);
 wxSize wxGetDisplaySize();
 //@}
 
-/** @ingroup group_funcmacro_gdi */
+/** @addtogroup group_funcmacro_gdi */
 //@{
 /**
     Returns the display size in millimeters.
 
+    For the version taking @a width and @a header arguments, either of them
+    can be @NULL if the caller is not interested in the returned value.
+
+    @see wxGetDisplayPPI()
+
     @header{wx/gdicmn.h}
 */
 void wxDisplaySizeMM(int* width, int* height);