[dia] dox: more documentation for ObjectParts

[Hans Breuer <hans src gnome org>]

commit 5cecb798944c329185f54e50685448b2d4d0bbac
Author: Hans Breuer <hans breuer org>
Date:   Sun Sep 30 23:27:07 2012 +0200

    dox: more documentation for ObjectParts

 lib/geometry.c |   25 +++++++++++++++++++++----
 lib/geometry.h |    3 +++
 lib/text.h     |   11 +++++++++++
 3 files changed, 35 insertions(+), 4 deletions(-)
---
diff --git a/lib/geometry.c b/lib/geometry.c
index bfaea16..12e7bb5 100644
--- a/lib/geometry.c
+++ b/lib/geometry.c
@@ -677,6 +677,11 @@ calculate_object_edge(Point *objmid, Point *end, DiaObject *obj)
   return mid2;
 }
 
+/*!
+ * \brief Check the matrix if it has any effect
+ * @param m matrix
+ * \extends _DiaMatrix
+ */
 gboolean 
 dia_matrix_is_identity (const DiaMatrix *matrix)
 {
@@ -692,9 +697,14 @@ dia_matrix_is_identity (const DiaMatrix *matrix)
   return FALSE;
 }
 
-/**
- * Splitting the givne matrix into angle and scales
+/*!
+ * \brief Splitting the given matrix into angle and scales
+ * @param m matrix
+ * @param angle in radians
+ * @param sx horizontal scale
+ * @param sy vertical scale
  *
+ * \code
  * with     scale    rotate
  *   xx yx    sx 0     cos(x) sin(x)
  *   xy yy    0  sy   -sin(x) cos(x)
@@ -703,6 +713,8 @@ dia_matrix_is_identity (const DiaMatrix *matrix)
  * ryx =  sx *  sin(a) + 0  *  cos(a)
  * rxy =  0  *  cos(a) + sy * -sin(a)
  * ryy =  0  * -sin(a) + sy *  cos(a)
+ * \endcode
+ * \extends _DiaMatrix
  */
 gboolean
 dia_matrix_get_angle_and_scales (const DiaMatrix *m,
@@ -742,8 +754,13 @@ dia_matrix_get_angle_and_scales (const DiaMatrix *m,
   return no_skew;
 }
 
-/**
- * Scale in the coordinate system of the shape, afterwards rotate
+/*!
+ * \brief Scale in the coordinate system of the shape, afterwards rotate
+ * @param m matrix
+ * @param angle in radians
+ * @param sx horizontal scale
+ * @param sy vertical scale
+ * \extends _DiaMatrix
  */
 void 
 dia_matrix_set_angle_and_scales (DiaMatrix *m,
diff --git a/lib/geometry.h b/lib/geometry.h
index 68300fe..6b48c47 100644
--- a/lib/geometry.h
+++ b/lib/geometry.h
@@ -102,6 +102,7 @@ struct _IntRectangle {
 
 /*! 
  * \brief BezPoint is a bezier point forming _Bezierline or _Beziergon
+ * \ingroup ObjectParts
  */
 struct _BezPoint {
   enum {
@@ -118,6 +119,8 @@ struct _BezPoint {
  * \brief DiaMatrix used for affine transformation
  *
  * The struct is intentionally binary compatible with cairo_matrix_t.
+ *
+ * \ingroup ObjectParts
  */
 struct _DiaMatrix {
   real xx; real yx;
diff --git a/lib/text.h b/lib/text.h
index f2c00ad..0368a8d 100644
--- a/lib/text.h
+++ b/lib/text.h
@@ -30,6 +30,16 @@ typedef enum {
 #include "focus.h"
 #include "dia_xml.h" /* for AttributeNode */
 
+/*!
+ * \brief Multiline text representation
+ *
+ * The Text object provides high level service for on canvas text editing.
+ *
+ * It is used in various _DiaObject implementations, but also part of the
+ * _DiaRenderer interface
+ *
+ * \ingroup ObjectParts
+ */
 struct _Text {
   /* don't change these values directly, use the text_set* functions */
   
@@ -57,6 +67,7 @@ struct _Text {
 
 
 /* makes an internal copy of the string */
+/*! \brief Text object creation \memberof _Text */
 Text *new_text(const char *string, DiaFont *font, real height,
 	       Point *pos, Color *color, Alignment align);
 Text *new_text_default(Point *pos, Color *color, Alignment align);