[gegl] Fix/improve documentation for gegl_path_{set,get}



commit a6f1f6cf8cc84ada9f22eecfcd16eeb839d6cdcb
Author: Jon Nordby <jononor gmail com>
Date:   Sat Apr 9 14:46:19 2011 +0200

    Fix/improve documentation for gegl_path_{set,get}

 gegl/property-types/gegl-path.c |    7 -------
 gegl/property-types/gegl-path.h |   16 +++++++---------
 2 files changed, 7 insertions(+), 16 deletions(-)
---
diff --git a/gegl/property-types/gegl-path.c b/gegl/property-types/gegl-path.c
index eb8c91e..986605a 100644
--- a/gegl/property-types/gegl-path.c
+++ b/gegl/property-types/gegl-path.c
@@ -796,10 +796,6 @@ void gegl_path_thaw (GeglPath *path)
   gegl_path_emit_changed (path, NULL); /* expose a full changed */
 }
 
-/**
- * gegl_path_get_matrix: (skip)
- */
-void
 gegl_path_get_matrix (GeglPath    *path,
                       GeglMatrix3  *matrix)
 {
@@ -807,9 +803,6 @@ gegl_path_get_matrix (GeglPath    *path,
   gegl_matrix3_copy_into (matrix, &priv->matrix);
 }
 
-/**
- * gegl_path_set_matrix: (skip)
- */
 void
 gegl_path_set_matrix (GeglPath    *path,
                       GeglMatrix3  *matrix)
diff --git a/gegl/property-types/gegl-path.h b/gegl/property-types/gegl-path.h
index 7e5dcaf..3d19097 100644
--- a/gegl/property-types/gegl-path.h
+++ b/gegl/property-types/gegl-path.h
@@ -178,11 +178,12 @@ gchar              * gegl_path_to_string      (GeglPath    *path);
 /**
  * gegl_path_set_matrix:
  * @path: a #GeglPath
- * @matrix: a GeglMatrix3
+ * @matrix: a #GeglMatrix3 to copy the matrix from
  *
- * Set the matrix of the path, the path is thransformed through this
- * matrix when being evaluated. Causing the calcuated positions and
- * length to be changed by the transform.
+ * Set the transformation matrix of the path.
+ *
+ * The path is transformed through this matrix when being evaluated,
+ * causing the calcuated positions and length to be changed by the transform.
  */
 void                 gegl_path_set_matrix     (GeglPath    *path,
                                                GeglMatrix3 *matrix);
@@ -190,12 +191,9 @@ void                 gegl_path_set_matrix     (GeglPath    *path,
 /**
  * gegl_path_get_matrix:
  * @path: a #GeglPath
- * @matrix: a GeglMatrix3
- *
- * Retrieve the node of the path at positiong @pos.
+ * @matrix: a #GeglMatrix3 to copy the matrix into
  *
- * Return value: pointer to the node of the path at position @pos or NULL if no
- * such node.
+ * Get the transformation matrix of the path.
  */
 void                 gegl_path_get_matrix     (GeglPath    *path,
                                                GeglMatrix3 *matrix);



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