[goocanvas] Added docs for GooCanvasAnchorType.



commit 17e3ae499287da8f842e670b6f63318de0fd21d2
Author: Damon Chaplin <damon gnome org>
Date:   Mon Jan 10 01:00:08 2011 +0000

    Added docs for GooCanvasAnchorType.

 ChangeLog                   |    4 ++++
 docs/goocanvas-sections.txt |    6 ++++++
 src/goocanvasutils.h        |   24 +++++++++++++++++++++++-
 3 files changed, 33 insertions(+), 1 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index a98169a..136e337 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,9 @@
 2011-01-10  Damon Chaplin  <damon gnome org>
 
+	* src/goocanvasutils.h (enum): added docs for GooCanvasAnchorType.
+
+2011-01-10  Damon Chaplin  <damon gnome org>
+
 	* src/goocanvasimage.c: added "alpha" property. Patch from xapantu
 	plus a few changes.
 
diff --git a/docs/goocanvas-sections.txt b/docs/goocanvas-sections.txt
index 32f506d..96f1bed 100644
--- a/docs/goocanvas-sections.txt
+++ b/docs/goocanvas-sections.txt
@@ -714,6 +714,9 @@ GooCanvasPointerEvents
 GooCanvasAnimateType
 
 <SUBSECTION>
+GooCanvasAnchorType
+
+<SUBSECTION>
 GooCanvasPoints
 goo_canvas_points_new
 goo_canvas_points_ref
@@ -758,6 +761,9 @@ goo_cairo_pattern_get_type
 GOO_TYPE_CANVAS_LINE_DASH
 goo_canvas_line_dash_get_type
 
+GOO_TYPE_CANVAS_ANCHOR_TYPE
+goo_canvas_anchor_type_get_type
+
 GOO_TYPE_CAIRO_ANTIALIAS
 GOO_TYPE_CAIRO_FILL_RULE
 GOO_TYPE_CAIRO_LINE_CAP
diff --git a/src/goocanvasutils.h b/src/goocanvasutils.h
index 220ce9b..23bbda0 100644
--- a/src/goocanvasutils.h
+++ b/src/goocanvasutils.h
@@ -139,7 +139,29 @@ typedef enum
 
 
 
-/* Anchor types */
+/**
+ * GooCanvasAnchorType
+ * @GOO_CANVAS_ANCHOR_CENTER: the anchor is in the center of the object.
+ * @GOO_CANVAS_ANCHOR_NORTH: the anchor is at the top of the object, centered horizontally.
+ * @GOO_CANVAS_ANCHOR_NORTH_WEST: the anchor is at the top-left of the object.
+ * @GOO_CANVAS_ANCHOR_NORTH_EAST: the anchor is at the top-right of the object.
+ * @GOO_CANVAS_ANCHOR_SOUTH: the anchor is at the bottom of the object, centered horizontally.
+ * @GOO_CANVAS_ANCHOR_SOUTH_WEST: the anchor is at the bottom-left of the object.
+ * @GOO_CANVAS_ANCHOR_SOUTH_EAST: the anchor is at the bottom-right of the object.
+ * @GOO_CANVAS_ANCHOR_WEST: the anchor is on the left of the object, centered vertically.
+ * @GOO_CANVAS_ANCHOR_EAST: the anchor is on the right of the object, centered vertically.
+ * @GOO_CANVAS_ANCHOR_N: see GOO_CANVAS_ANCHOR_NORTH.
+ * @GOO_CANVAS_ANCHOR_NW: see GOO_CANVAS_ANCHOR_NORTH_WEST.
+ * @GOO_CANVAS_ANCHOR_NE: see GOO_CANVAS_ANCHOR_NORTH_EAST.
+ * @GOO_CANVAS_ANCHOR_S: see GOO_CANVAS_ANCHOR_SOUTH.
+ * @GOO_CANVAS_ANCHOR_SW: see GOO_CANVAS_ANCHOR_SOUTH_WEST.
+ * @GOO_CANVAS_ANCHOR_SE: see GOO_CANVAS_ANCHOR_SOUTH_EAST.
+ * @GOO_CANVAS_ANCHOR_W: see GOO_CANVAS_ANCHOR_WEST.
+ * @GOO_CANVAS_ANCHOR_E: see GOO_CANVAS_ANCHOR_EAST.
+ *
+ * GooCanvasAnchorType is used to specify the positions of objects relative to
+ * a particular anchor point.
+ */
 typedef enum
 {
   GOO_CANVAS_ANCHOR_CENTER,



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]