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
This commit is contained in:
Matthias Clasen 2016-01-20 13:12:13 -05:00
parent 4f6ea16c2e
commit 51f05a00ae

View File

@ -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,