[gtk] gsk: API docs fixes



commit 884088f64967d5269fc829b9634206897fce0108
Author: Bastien Nocera <hadess hadess net>
Date:   Thu Mar 7 16:29:28 2019 +0100

    gsk: API docs fixes
    
    gsk/gskenums.h:181: Error: Gsk: multiple "@GSK_TRANSFORM_CATEGORY_2D" parameters for identifier 
"GskTransformCategory":
     * @GSK_TRANSFORM_CATEGORY_2D: The matrix is a 2D matrix. This is equivalent
        ^
    gsk/gsktransform.c:1342: Warning: Gsk: gsk_transform_to_2d: unknown parameter 'm' in documentation 
comment, should be 'self'
    gsk/gsktransform.c:1368: Warning: Gsk: gsk_transform_to_2d: invalid return annotation
    gsk/gsktransform.c:1461: Warning: Gsk: gsk_transform_to_translate: unknown parameter 'm' in documentation 
comment, should be 'self'

 gsk/gskenums.h     | 2 +-
 gsk/gsktransform.c | 7 ++-----
 2 files changed, 3 insertions(+), 6 deletions(-)
---
diff --git a/gsk/gskenums.h b/gsk/gskenums.h
index aa6978cfe4..aaaa3b4cb9 100644
--- a/gsk/gskenums.h
+++ b/gsk/gskenums.h
@@ -176,7 +176,7 @@ typedef enum {
  *     determined.
  * @GSK_TRANSFORM_CATEGORY_ANY: Analyzing the matrix concluded that it does
  *     not fit in any other category.
- * @GSK_TRANSFORM_CATEGORY_2D: The matrix is a 3D matrix. This means that
+ * @GSK_TRANSFORM_CATEGORY_3D: The matrix is a 3D matrix. This means that
  *     the w column (the last column) has the values (0, 0, 0, 1).
  * @GSK_TRANSFORM_CATEGORY_2D: The matrix is a 2D matrix. This is equivalent
  *     to graphene_matrix_is_2d() returning %TRUE. In particular, this
diff --git a/gsk/gsktransform.c b/gsk/gsktransform.c
index a4da1cfad3..d5e4ac4e5a 100644
--- a/gsk/gsktransform.c
+++ b/gsk/gsktransform.c
@@ -1339,7 +1339,7 @@ gsk_transform_to_matrix (GskTransform      *self,
 
 /**
  * gsk_transform_to_2d:
- * @m: a 2D #GskTransform
+ * @self: a 2D #GskTransform
  * @out_xx: (out): return location for the xx member
  * @out_yx: (out): return location for the yx member
  * @out_xy: (out): return location for the xy member
@@ -1364,9 +1364,6 @@ gsk_transform_to_matrix (GskTransform      *self,
  * This function can be used to convert between a #GskTransform
  * and a matrix type from other 2D drawing libraries, in particular
  * Cairo.
- *
- * Returns: %TRUE if the matrix is compatible with an 2D
- *   transformation matrix.
  */
 void
 gsk_transform_to_2d (GskTransform *self,
@@ -1458,7 +1455,7 @@ gsk_transform_to_affine (GskTransform *self,
 
 /**
  * gsk_transform_to_translate:
- * @m: a #GskTransform
+ * @self: a #GskTransform
  * @out_dx: (out): return location for the translation
  *     in the x direction
  * @out_dy: (out): return location for the translation


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