summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBenjamin Otte <otte@redhat.com>2010-05-28 21:06:58 +0200
committerBenjamin Otte <otte@redhat.com>2010-06-07 13:37:48 +0200
commit534c14729921cbc2f8e24575eb792de9ddb96e23 (patch)
tree65492d591bddf2ad8b021cb7708fb5944c1f4cbe
parent0fc6f08981604ffdd0109362dcbbd9773501cd9a (diff)
region: clarify docs of cairo_region_equal()
-rw-r--r--src/cairo-region.c9
1 files changed, 5 insertions, 4 deletions
diff --git a/src/cairo-region.c b/src/cairo-region.c
index 1df44b84..565a7de6 100644
--- a/src/cairo-region.c
+++ b/src/cairo-region.c
@@ -760,13 +760,14 @@ slim_hidden_def (cairo_region_contains_point);
/**
* cairo_region_equal:
- * @region_a: a #cairo_region_t
- * @region_b: a #cairo_region_t
+ * @region_a: a #cairo_region_t or %NULL
+ * @region_b: a #cairo_region_t or %NULL
*
- * Compares whether region_a is equivalent to region_b.
+ * Compares whether region_a is equivalent to region_b. %NULL as an argument
+ * is equal to itself, but not to any non-%NULL region.
*
* Return value: %TRUE if both regions contained the same coverage,
- * %FALSE if it is not.
+ * %FALSE if it is not or any region is in an error status.
*
* Since: 1.10
**/