From a4c20184524fd874e64ce2fcd3f05a97cb34155d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Javier=20Jard=C3=B3n?= Date: Mon, 4 Oct 2010 03:19:43 +0200 Subject: [PATCH] docs: Move documentation to inline comments: regions --- docs/reference/gdk/tmpl/.gitignore | 1 + docs/reference/gdk/tmpl/regions.sgml | 72 ---------------------------- gdk/gdkrectangle.c | 20 ++++++++ gdk/gdktypes.h | 14 ++++++ 4 files changed, 35 insertions(+), 72 deletions(-) delete mode 100644 docs/reference/gdk/tmpl/regions.sgml diff --git a/docs/reference/gdk/tmpl/.gitignore b/docs/reference/gdk/tmpl/.gitignore index ae9a982634..905a6f25fa 100644 --- a/docs/reference/gdk/tmpl/.gitignore +++ b/docs/reference/gdk/tmpl/.gitignore @@ -1,3 +1,4 @@ cairo_interaction.sgml dnd.sgml +regions.sgml windows.sgml diff --git a/docs/reference/gdk/tmpl/regions.sgml b/docs/reference/gdk/tmpl/regions.sgml deleted file mode 100644 index 5236c54230..0000000000 --- a/docs/reference/gdk/tmpl/regions.sgml +++ /dev/null @@ -1,72 +0,0 @@ - -Points and Rectangles - - -Simple graphical data types - - - -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. - - - - - - - - - - - - - - - -Defines the x and y coordinates of a point. - - -@x: the x coordinate of the point. -@y: the y coordinate of the point. - - - -Defines the position and size of a rectangle. It is identical to -#cairo_rectangle_int_t. - - - - - - - - -@src1: -@src2: -@dest: -@Returns: - - - - - - - -@src1: -@src2: -@dest: - - diff --git a/gdk/gdkrectangle.c b/gdk/gdkrectangle.c index 1b282476e5..03ce78c743 100644 --- a/gdk/gdkrectangle.c +++ b/gdk/gdkrectangle.c @@ -28,6 +28,26 @@ #include +/** + * 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 diff --git a/gdk/gdktypes.h b/gdk/gdktypes.h index a5543d9338..aaa17b59e1 100644 --- a/gdk/gdktypes.h +++ b/gdk/gdktypes.h @@ -64,6 +64,13 @@ G_BEGIN_DECLS /* Type definitions for the basic structures. */ typedef struct _GdkPoint GdkPoint; + +/** + * GdkRectangle: + * + * Defines the position and size of a rectangle. It is identical to + * #cairo_rectangle_int_t. + */ typedef cairo_rectangle_int_t GdkRectangle; typedef struct _GdkAtom *GdkAtom; @@ -245,6 +252,13 @@ typedef enum GDK_ALL_EVENTS_MASK = 0x3FFFFE } GdkEventMask; +/** + * GdkPoint: + * @x: the x coordinate of the point. + * @y: the y coordinate of the point. + * + * Defines the x and y coordinates of a point. + */ struct _GdkPoint { gint x;