summaryrefslogtreecommitdiff
path: root/gdk/gdkrectangle.c
diff options
context:
space:
mode:
authorMatthias Clasen <mclasen@redhat.com>2016-01-20 13:12:13 -0500
committerMatthias Clasen <mclasen@redhat.com>2016-01-20 13:44:34 -0500
commit51f05a00aef5e54f4ecd006f49ed9d1d0497aae8 (patch)
tree243ec42531037c0b3d763a0529783f57bfacc0cb /gdk/gdkrectangle.c
parent4f6ea16c2e747c32e78285129df4b98b2a80c10d (diff)
downloadgtk+-51f05a00aef5e54f4ecd006f49ed9d1d0497aae8.tar.gz
Clarify docs for gdk_rectangle_union
This function does not ignore empty rectangles. Since this is a fairly subtle point about the behavior, it is worth spelling this out in the documentation. We've had a bug open about this for a long time: https://bugzilla.gnome.org/show_bug.cgi?id=464528
Diffstat (limited to 'gdk/gdkrectangle.c')
-rw-r--r--gdk/gdkrectangle.c3
1 files changed, 3 insertions, 0 deletions
diff --git a/gdk/gdkrectangle.c b/gdk/gdkrectangle.c
index 84abd2ffd7..491de6c1e5 100644
--- a/gdk/gdkrectangle.c
+++ b/gdk/gdkrectangle.c
@@ -58,6 +58,9 @@
* The union of rectangles @src1 and @src2 is the smallest rectangle which
* includes both @src1 and @src2 within it.
* It is allowed for @dest to be the same as either @src1 or @src2.
+ *
+ * Note that this function does not ignore 'empty' rectangles (ie. with
+ * zero width or height).
*/
void
gdk_rectangle_union (const GdkRectangle *src1,