*From*: Niels De Graef <nielsdg src gnome org>*To*: commits-list gnome org*Cc*:*Subject*: [gimp] libgimpmath: Fix some vector gi-docgen annotations*Date*: Tue, 28 Dec 2021 22:55:16 +0000 (UTC)

commit 7473b24492284e62f84230e17493940da9e97ba7 Author: Niels De Graef <nielsdegraef gmail com> Date: Tue Dec 28 23:54:31 2021 +0100 libgimpmath: Fix some vector gi-docgen annotations libgimpmath/gimpvector.c | 39 +++++++++++++++++++-------------------- 1 file changed, 19 insertions(+), 20 deletions(-) --- diff --git a/libgimpmath/gimpvector.c b/libgimpmath/gimpvector.c index 090e448546..0e75352463 100644 --- a/libgimpmath/gimpvector.c +++ b/libgimpmath/gimpvector.c @@ -75,9 +75,9 @@ static const GimpVector3 gimp_vector3_unit_z = { 0.0, 0.0, 1.0 }; * @x: the X coordinate. * @y: the Y coordinate. * - * Creates a #GimpVector2 of coordinates @x and @y. + * Creates a [struct@Vector2] of coordinates @x and @y. * - * Returns: the resulting #GimpVector2. + * Returns: the resulting vector **/ GimpVector2 gimp_vector2_new (gdouble x, @@ -126,8 +126,8 @@ gimp_vector2_length (const GimpVector2 *vector) * gimp_vector2_length_val: * @vector: a #GimpVector2. * - * This function is identical to gimp_vector2_length() but the - * vector is passed by value rather than by reference. + * Identical to [method@Vector2.length], but the vector is passed by value + * rather than by reference. * * Returns: the length of @vector (a positive gdouble). **/ @@ -158,8 +158,8 @@ gimp_vector2_mul (GimpVector2 *vector, * @vector: a #GimpVector2. * @factor: a scalar. * - * This function is identical to gimp_vector2_mul() but the vector is - * passed by value rather than by reference. + * Identical to [method Vector2 mul], but the vector is passed by value rather + * than by reference. * * Returns: the resulting #GimpVector2. **/ @@ -206,7 +206,7 @@ gimp_vector2_normalize (GimpVector2 *vector) * gimp_vector2_normalize_val: * @vector: a #GimpVector2. * - * This function is identical to gimp_vector2_normalize() but the + * Identical to [method@Vector2.normalize], but the * vector is passed by value rather than by reference. * * Returns: a #GimpVector2 parallel to @vector, pointing in the same @@ -250,7 +250,7 @@ gimp_vector2_neg (GimpVector2 *vector) * gimp_vector2_neg_val: * @vector: a #GimpVector2. * - * This function is identical to gimp_vector2_neg() but the vector + * Identical to [method Vector2 neg], but the vector * is passed by value rather than by reference. * * Returns: the negated #GimpVector2. @@ -368,7 +368,7 @@ gimp_vector2_inner_product (const GimpVector2 *vector1, * @vector1: the first #GimpVector2. * @vector2: the second #GimpVector2. * - * This function is identical to gimp_vector2_inner_product() but the + * Identical to [method@Vector2.inner_product], but the * vectors are passed by value rather than by reference. * * Returns: The inner product. @@ -412,7 +412,7 @@ gimp_vector2_cross_product (const GimpVector2 *vector1, * @vector1: the first #GimpVector2. * @vector2: the second #GimpVector2. * - * This function is identical to gimp_vector2_cross_product() but the + * Identical to [method@Vector2.cross_product], but the * vectors are passed by value rather than by reference. * * Returns: The cross product. @@ -453,7 +453,7 @@ gimp_vector2_rotate (GimpVector2 *vector, * @vector: a #GimpVector2. * @alpha: an angle (in radians). * - * This function is identical to gimp_vector2_rotate() but the vector + * Identical to [method@Vector2.rotate], but the vector * is passed by value rather than by reference. * * Returns: a #GimpVector2 representing @vector rotated by @alpha @@ -498,7 +498,7 @@ gimp_vector2_normal (GimpVector2 *vector) * gimp_vector2_normal_val: * @vector: a #GimpVector2. * - * This function is identical to gimp_vector2_normal() but the vector + * Identical to [method@Vector2.normal], but the vector * is passed by value rather than by reference. * * Returns: a #GimpVector2 perpendicular to @vector, with a length of 1.0. @@ -585,7 +585,7 @@ gimp_vector3_length (const GimpVector3 *vector) * gimp_vector3_length_val: * @vector: a #GimpVector3. * - * This function is identical to gimp_vector3_length() but the vector + * Identical to [method@Vector3.length], but the vector * is passed by value rather than by reference. * * Returns: the length of @vector (a positive gdouble). @@ -620,7 +620,7 @@ gimp_vector3_mul (GimpVector3 *vector, * @vector: a #GimpVector3. * @factor: a scalar. * - * This function is identical to gimp_vector3_mul() but the vector is + * Identical to [method Vector3 mul], but the vector is * passed by value rather than by reference. * * Returns: the resulting #GimpVector3. @@ -669,7 +669,7 @@ gimp_vector3_normalize (GimpVector3 *vector) * gimp_vector3_normalize_val: * @vector: a #GimpVector3. * - * This function is identical to gimp_vector3_normalize() but the + * Identical to [method@Vector3.normalize], but the * vector is passed by value rather than by reference. * * Returns: a #GimpVector3 parallel to @vector, pointing in the same @@ -715,7 +715,7 @@ gimp_vector3_neg (GimpVector3 *vector) * gimp_vector3_neg_val: * @vector: a #GimpVector3. * - * This function is identical to gimp_vector3_neg() but the vector + * Identical to [method Vector3 neg], but the vector * is passed by value rather than by reference. * * Returns: the negated #GimpVector3. @@ -840,7 +840,7 @@ gimp_vector3_inner_product (const GimpVector3 *vector1, * @vector1: the first #GimpVector3. * @vector2: the second #GimpVector3. * - * This function is identical to gimp_vector3_inner_product() but the + * Identical to [method@Vector3.inner_product], but the * vectors are passed by value rather than by reference. * * Returns: The inner product. @@ -887,7 +887,7 @@ gimp_vector3_cross_product (const GimpVector3 *vector1, * @vector1: the first #GimpVector3. * @vector2: the second #GimpVector3. * - * This function is identical to gimp_vector3_cross_product() but the + * Identical to [method@Vector3.cross_product], but the * vectors are passed by value rather than by reference. * * Returns: The cross product. @@ -956,7 +956,7 @@ gimp_vector3_rotate (GimpVector3 *vector, * @beta: the angle (in radian) of rotation around the Y axis. * @gamma: the angle (in radian) of rotation around the X axis. * - * This function is identical to gimp_vector3_rotate() but the vectors + * Identical to [method@Vector3.rotate], but the vectors * are passed by value rather than by reference. * * Returns: the rotated vector. @@ -1011,7 +1011,6 @@ gimp_vector3_rotate_val (GimpVector3 vector, * to the plane z = @p->z (parallel to XY), from the @vp point of view * through the screen (@sx, @sy)->(@sx + @w, @sy + @h) **/ - void gimp_vector_2d_to_3d (gint sx, gint sy,

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