summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthias Clasen <mclasen@redhat.com>2021-06-04 08:44:37 -0400
committerMatthias Clasen <mclasen@redhat.com>2021-06-04 09:49:05 -0400
commite437c55142c0a1ed5cb774c186927a59f49cb9b9 (patch)
tree878009112f2b590ffe5b8587f3b99db2b818a1b4
parent4c9bd6ed9aefdf244d03df315078be718d060140 (diff)
downloadgtk+-e437c55142c0a1ed5cb774c186927a59f49cb9b9.tar.gz
Add a doc comment for gsk_rounded_rect_is_circular
-rw-r--r--gsk/gskroundedrect.c12
1 files changed, 11 insertions, 1 deletions
diff --git a/gsk/gskroundedrect.c b/gsk/gskroundedrect.c
index 81a5b96e61..42df2bf06c 100644
--- a/gsk/gskroundedrect.c
+++ b/gsk/gskroundedrect.c
@@ -310,7 +310,17 @@ gsk_rounded_rect_scale_affine (GskRoundedRect *dest,
}
}
-/* XXX: Find a better name */
+/*<private>
+ * gsk_rounded_rect_is_circular:
+ * @self: the `GskRoundedRect` to check
+ *
+ * Checks if all corners of @self are quarter-circles (as
+ * opposed to quarter-ellipses).
+ *
+ * Note that different corners can still have different radii.
+ *
+ * Returns: %TRUE if the rectangle is circular.
+ */
gboolean
gsk_rounded_rect_is_circular (const GskRoundedRect *self)
{