procyberian/gimp
2
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/gimp.git synced 2025-07-03 17:33:25 +00:00
Code Issues 1 Projects 1 Releases Packages Wiki Activity Actions

libgimpmath: Fix some vector gi-docgen annotations

Browse source
This commit is contained in:
Niels De Graef 2021-12-28 23:54:31 +01:00
parent 6fc26cfbc4
commit 7473b24492
1 changed files with 19 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

39
libgimpmath/gimpvector.c
View file

@ -75,9 +75,9 @@ static const GimpVector3 gimp_vector3_unit_z = { 0.0, 0.0, 1.0 };
* @x: the X coordinate. * @x: the X coordinate.
* @y: the Y 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 GimpVector2
gimp_vector2_new (gdouble x, gimp_vector2_new (gdouble x,
@ -126,8 +126,8 @@ gimp_vector2_length (const GimpVector2 *vector)
* gimp_vector2_length_val: * gimp_vector2_length_val:
* @vector: a #GimpVector2. * @vector: a #GimpVector2.
* *
* This function is identical to gimp_vector2_length() but the * Identical to [method@Vector2.length], but the vector is passed by value
* vector is passed by value rather than by reference. * rather than by reference.
* *
* Returns: the length of @vector (a positive gdouble). * Returns: the length of @vector (a positive gdouble).
**/ **/
@ -158,8 +158,8 @@ gimp_vector2_mul (GimpVector2 *vector,
* @vector: a #GimpVector2. * @vector: a #GimpVector2.
* @factor: a scalar. * @factor: a scalar.
* *
* This function is identical to gimp_vector2_mul() but the vector is * Identical to [method@Vector2.mul], but the vector is passed by value rather
* passed by value rather than by reference. * than by reference.
* *
* Returns: the resulting #GimpVector2. * Returns: the resulting #GimpVector2.
**/ **/
@ -206,7 +206,7 @@ gimp_vector2_normalize (GimpVector2 *vector)
* gimp_vector2_normalize_val: * gimp_vector2_normalize_val:
* @vector: a #GimpVector2. * @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. * vector is passed by value rather than by reference.
* *
* Returns: a #GimpVector2 parallel to @vector, pointing in the same * Returns: a #GimpVector2 parallel to @vector, pointing in the same
@ -250,7 +250,7 @@ gimp_vector2_neg (GimpVector2 *vector)
* gimp_vector2_neg_val: * gimp_vector2_neg_val:
* @vector: a #GimpVector2. * @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. * is passed by value rather than by reference.
* *
* Returns: the negated #GimpVector2. * Returns: the negated #GimpVector2.
@ -368,7 +368,7 @@ gimp_vector2_inner_product (const GimpVector2 *vector1,
* @vector1: the first #GimpVector2. * @vector1: the first #GimpVector2.
* @vector2: the second #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. * vectors are passed by value rather than by reference.
* *
* Returns: The inner product. * Returns: The inner product.
@ -412,7 +412,7 @@ gimp_vector2_cross_product (const GimpVector2 *vector1,
* @vector1: the first #GimpVector2. * @vector1: the first #GimpVector2.
* @vector2: the second #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. * vectors are passed by value rather than by reference.
* *
* Returns: The cross product. * Returns: The cross product.
@ -453,7 +453,7 @@ gimp_vector2_rotate (GimpVector2 *vector,
* @vector: a #GimpVector2. * @vector: a #GimpVector2.
* @alpha: an angle (in radians). * @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. * is passed by value rather than by reference.
* *
* Returns: a #GimpVector2 representing @vector rotated by @alpha * Returns: a #GimpVector2 representing @vector rotated by @alpha
@ -498,7 +498,7 @@ gimp_vector2_normal (GimpVector2 *vector)
* gimp_vector2_normal_val: * gimp_vector2_normal_val:
* @vector: a #GimpVector2. * @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. * is passed by value rather than by reference.
* *
* Returns: a #GimpVector2 perpendicular to @vector, with a length of 1.0. * 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: * gimp_vector3_length_val:
* @vector: a #GimpVector3. * @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. * is passed by value rather than by reference.
* *
* Returns: the length of @vector (a positive gdouble). * Returns: the length of @vector (a positive gdouble).
@ -620,7 +620,7 @@ gimp_vector3_mul (GimpVector3 *vector,
* @vector: a #GimpVector3. * @vector: a #GimpVector3.
* @factor: a scalar. * @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. * passed by value rather than by reference.
* *
* Returns: the resulting #GimpVector3. * Returns: the resulting #GimpVector3.
@ -669,7 +669,7 @@ gimp_vector3_normalize (GimpVector3 *vector)
* gimp_vector3_normalize_val: * gimp_vector3_normalize_val:
* @vector: a #GimpVector3. * @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. * vector is passed by value rather than by reference.
* *
* Returns: a #GimpVector3 parallel to @vector, pointing in the same * Returns: a #GimpVector3 parallel to @vector, pointing in the same
@ -715,7 +715,7 @@ gimp_vector3_neg (GimpVector3 *vector)
* gimp_vector3_neg_val: * gimp_vector3_neg_val:
* @vector: a #GimpVector3. * @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. * is passed by value rather than by reference.
* *
* Returns: the negated #GimpVector3. * Returns: the negated #GimpVector3.
@ -840,7 +840,7 @@ gimp_vector3_inner_product (const GimpVector3 *vector1,
* @vector1: the first #GimpVector3. * @vector1: the first #GimpVector3.
* @vector2: the second #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. * vectors are passed by value rather than by reference.
* *
* Returns: The inner product. * Returns: The inner product.
@ -887,7 +887,7 @@ gimp_vector3_cross_product (const GimpVector3 *vector1,
* @vector1: the first #GimpVector3. * @vector1: the first #GimpVector3.
* @vector2: the second #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. * vectors are passed by value rather than by reference.
* *
* Returns: The cross product. * Returns: The cross product.
@ -956,7 +956,7 @@ gimp_vector3_rotate (GimpVector3 *vector,
* @beta: the angle (in radian) of rotation around the Y axis. * @beta: the angle (in radian) of rotation around the Y axis.
* @gamma: the angle (in radian) of rotation around the X 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. * are passed by value rather than by reference.
* *
* Returns: the rotated vector. * 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 * to the plane z = @p->z (parallel to XY), from the @vp point of view
* through the screen (@sx, @sy)->(@sx + @w, @sy + @h) * through the screen (@sx, @sy)->(@sx + @w, @sy + @h)
**/ **/
void void
gimp_vector_2d_to_3d (gint sx, gimp_vector_2d_to_3d (gint sx,
gint sy, gint sy,