summaryrefslogtreecommitdiff
path: root/gdk/gdkrectangle.c
diff options
context:
space:
mode:
authorJavier Jardón <jjardon@gnome.org>2010-10-04 03:19:43 +0200
committerJavier Jardón <jjardon@gnome.org>2010-10-04 03:19:43 +0200
commita4c20184524fd874e64ce2fcd3f05a97cb34155d (patch)
tree0cb0ee576c54c88b2bed6dee03b873977181eb52 /gdk/gdkrectangle.c
parent4e71a4df7b4368954925401d0f028ddecd00004a (diff)
downloadgtk+-a4c20184524fd874e64ce2fcd3f05a97cb34155d.tar.gz
docs: Move documentation to inline comments: regions
Diffstat (limited to 'gdk/gdkrectangle.c')
-rw-r--r--gdk/gdkrectangle.c20
1 files changed, 20 insertions, 0 deletions
diff --git a/gdk/gdkrectangle.c b/gdk/gdkrectangle.c
index 1b282476e5..03ce78c743 100644
--- a/gdk/gdkrectangle.c
+++ b/gdk/gdkrectangle.c
@@ -29,6 +29,26 @@
/**
+ * SECTION:regions
+ * @Short_description: Simple graphical data types
+ * @Title: Points and Rectangles
+ *
+ * GDK provides the #GdkPoint and #GdkRectangle data types for representing pixels
+ * and sets of pixels on the screen. Together with Cairo's #cairo_region_t data
+ * type, they make up the central types for representing graphical data.
+ *
+ * #GdkPoint is a simple structure containing an x and y coordinate of a point.
+ *
+ * #GdkRectangle is a structure holding the position and size of a rectangle.
+ * The intersection of two rectangles can be computed with
+ * gdk_rectangle_intersect(). To find the union of two rectangles use
+ * gdk_rectangle_union().
+ *
+ * #cairo_region_t is usually used for managing clipping of graphical operations.
+ */
+
+
+/**
* gdk_rectangle_union:
* @src1: a #GdkRectangle
* @src2: a #GdkRectangle