[gtk/matthiasc/for-master: 3/5] Add a doc comment for gsk_rounded_rect_is_circular




commit e437c55142c0a1ed5cb774c186927a59f49cb9b9
Author: Matthias Clasen <mclasen redhat com>
Date:   Fri Jun 4 08:44:37 2021 -0400

    Add a doc comment for gsk_rounded_rect_is_circular

 gsk/gskroundedrect.c | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)
---
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)
 {


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