diff options
author | Matthias Clasen <mclasen@redhat.com> | 2021-05-18 17:05:26 -0400 |
---|---|---|
committer | Matthias Clasen <mclasen@redhat.com> | 2021-05-20 19:17:49 -0400 |
commit | 8ba16eb4f1e6df67d79a9d509a3a45126a032e46 (patch) | |
tree | bb493f2acbf893de29db9e393a4f364b7dd05ac2 /gsk | |
parent | ab6a5be0f860c29432b4a8e9d3a4cd3bbad0a63a (diff) | |
download | gtk+-8ba16eb4f1e6df67d79a9d509a3a45126a032e46.tar.gz |
Documentation fixes
Mostly fixing up indentation of continuation lines,
and other small cleanups.
Diffstat (limited to 'gsk')
-rw-r--r-- | gsk/gskenums.h | 23 | ||||
-rw-r--r-- | gsk/gskrenderer.c | 2 | ||||
-rw-r--r-- | gsk/gskrendernode.c | 3 | ||||
-rw-r--r-- | gsk/gsktransform.c | 39 |
4 files changed, 35 insertions, 32 deletions
diff --git a/gsk/gskenums.h b/gsk/gskenums.h index fdea6d74a5..bb4518d948 100644 --- a/gsk/gskenums.h +++ b/gsk/gskenums.h @@ -169,12 +169,11 @@ typedef enum { /** * GskSerializationError: - * @GSK_SERIALIZATION_UNSUPPORTED_FORMAT: The format can not be - * identified - * @GSK_SERIALIZATION_UNSUPPORTED_VERSION: The version of the data - * is not understood + * @GSK_SERIALIZATION_UNSUPPORTED_FORMAT: The format can not be identified + * @GSK_SERIALIZATION_UNSUPPORTED_VERSION: The version of the data is not + * understood * @GSK_SERIALIZATION_INVALID_DATA: The given data may not exist in - * a proper serialization + * a proper serialization * * Errors that can happen during (de)serialization. */ @@ -187,17 +186,17 @@ typedef enum { /** * GskTransformCategory: * @GSK_TRANSFORM_CATEGORY_UNKNOWN: The category of the matrix has not been - * determined. + * determined. * @GSK_TRANSFORM_CATEGORY_ANY: Analyzing the matrix concluded that it does - * not fit in any other category. + * not fit in any other category. * @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). + * 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 - * means that Cairo can deal with the matrix. + * to graphene_matrix_is_2d() returning %TRUE. In particular, this + * means that Cairo can deal with the matrix. * @GSK_TRANSFORM_CATEGORY_2D_AFFINE: The matrix is a combination of 2D scale - * and 2D translation operations. In particular, this means that any - * rectangle can be transformed exactly using this matrix. + * and 2D translation operations. In particular, this means that any + * rectangle can be transformed exactly using this matrix. * @GSK_TRANSFORM_CATEGORY_2D_TRANSLATE: The matrix is a 2D translation. * @GSK_TRANSFORM_CATEGORY_IDENTITY: The matrix is the identity matrix. * diff --git a/gsk/gskrenderer.c b/gsk/gskrenderer.c index f418bfabb2..45b2981a47 100644 --- a/gsk/gskrenderer.c +++ b/gsk/gskrenderer.c @@ -403,7 +403,7 @@ gsk_renderer_render_texture (GskRenderer *renderer, * @renderer: a `GskRenderer` * @root: a `GskRenderNode` * @region: (nullable): the `cairo_region_t` that must be redrawn or %NULL - * for the whole window + * for the whole window * * Renders the scene graph, described by a tree of `GskRenderNode` instances, * ensuring that the given @region gets redrawn. diff --git a/gsk/gskrendernode.c b/gsk/gskrendernode.c index ed1a1eb7f8..f99aaefa39 100644 --- a/gsk/gskrendernode.c +++ b/gsk/gskrendernode.c @@ -607,8 +607,7 @@ gsk_render_node_write_to_file (GskRenderNode *node, * * For a discussion of the supported format, see that function. * - * Returns: (nullable) (transfer full): a new `GskRenderNode` or %NULL on - * error. + * Returns: (nullable) (transfer full): a new `GskRenderNode` */ GskRenderNode * gsk_render_node_deserialize (GBytes *bytes, diff --git a/gsk/gsktransform.c b/gsk/gsktransform.c index 9448a4ef5e..cc1dea0e93 100644 --- a/gsk/gsktransform.c +++ b/gsk/gsktransform.c @@ -93,7 +93,7 @@ gsk_transform_has_class (GskTransform *self, * gsk_transform_alloc: * @transform_class: class structure for this self * @category: The category of this transform. Will be used to initialize - * the result's category together with &next's category + * the result's category together with &next's category * @next: (transfer full): Next transform to multiply with or %NULL if none * * Returns: (transfer full): the newly created #GskTransform @@ -226,7 +226,7 @@ static const GskTransformClass GSK_IDENTITY_TRANSFORM_CLASS = * which just results in an identity transform when simplified. * * Returns: %TRUE if this transform is a representation of - * the identity transform + * the identity transform **/ static gboolean gsk_transform_is_identity (GskTransform *self) @@ -1288,8 +1288,8 @@ static const GskTransformClass GSK_PERSPECTIVE_TRANSFORM_CLASS = * gsk_transform_perspective: * @next: (allow-none) (transfer full): the next transform * @depth: distance of the z=0 plane. Lower values give a more - * flattened pyramid and therefore a more pronounced - * perspective effect. + * flattened pyramid and therefore a more pronounced + * perspective effect. * * Applies a perspective projection transform. * @@ -1520,19 +1520,22 @@ gsk_transform_to_2d (GskTransform *self, * gsk_transform_to_affine: * @self: a `GskTransform` * @out_scale_x: (out): return location for the scale - * factor in the x direction + * factor in the x direction * @out_scale_y: (out): return location for the scale - * factor in the y direction + * factor in the y direction * @out_dx: (out): return location for the translation - * in the x direction + * in the x direction * @out_dy: (out): return location for the translation - * in the y direction + * in the y direction * * Converts a `GskTransform` to 2D affine transformation factors. * * @self must be a 2D transformation. If you are not - * sure, use gsk_transform_get_category() >= - * %GSK_TRANSFORM_CATEGORY_2D_AFFINE to check. + * sure, use + * + * gsk_transform_get_category() >= %GSK_TRANSFORM_CATEGORY_2D_AFFINE + * + * to check. */ void gsk_transform_to_affine (GskTransform *self, @@ -1586,15 +1589,18 @@ gsk_transform_to_affine (GskTransform *self, * gsk_transform_to_translate: * @self: a `GskTransform` * @out_dx: (out): return location for the translation - * in the x direction + * in the x direction * @out_dy: (out): return location for the translation - * in the y direction + * in the y direction * * Converts a `GskTransform` to a translation operation. * * @self must be a 2D transformation. If you are not - * sure, use gsk_transform_get_category() >= - * %GSK_TRANSFORM_CATEGORY_2D_TRANSLATE to check. + * sure, use + * + * gsk_transform_get_category() >= %GSK_TRANSFORM_CATEGORY_2D_TRANSLATE + * + * to check. */ void gsk_transform_to_translate (GskTransform *self, @@ -1677,8 +1683,7 @@ gsk_transform_transform (GskTransform *next, * between those cases, you should check @self is not %NULL * before calling this function. * - * Returns: (nullable): The inverted transform or %NULL if the transform - * cannot be inverted. + * Returns: (nullable): The inverted transform */ GskTransform * gsk_transform_invert (GskTransform *self) @@ -1705,7 +1710,7 @@ gsk_transform_invert (GskTransform *self) * * Checks two transforms for equality. * - * Returns: %TRUE if the two transforms perform the same operation. + * Returns: %TRUE if the two transforms perform the same operation */ gboolean gsk_transform_equal (GskTransform *first, |