[libdazzle: 4/5] docs: Add return info to dzl-cairo
- From: Christian Hergert <chergert src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [libdazzle: 4/5] docs: Add return info to dzl-cairo
- Date: Wed, 19 Dec 2018 21:50:26 +0000 (UTC)
commit 2809f4f27ea950f625fa2f1342b6b2a8bd335927
Author: FlyingPiMonster <flyingpimonster flyingpimonster net>
Date: Wed Dec 19 14:48:45 2018 -0600
docs: Add return info to dzl-cairo
src/util/dzl-cairo.c | 2 ++
src/util/dzl-cairo.h | 10 ++++++++++
2 files changed, 12 insertions(+)
---
diff --git a/src/util/dzl-cairo.c b/src/util/dzl-cairo.c
index c88bd97..c5ec23b 100644
--- a/src/util/dzl-cairo.c
+++ b/src/util/dzl-cairo.c
@@ -36,6 +36,8 @@
* @cr a cairo context
*
* Creates a region from the extents of the context's current clip area.
+ *
+ * Returns: (transfer full): A #CairoRegion.
*/
cairo_region_t *
dzl_cairo_region_create_from_clip_extents (cairo_t *cr)
diff --git a/src/util/dzl-cairo.h b/src/util/dzl-cairo.h
index cb7cd95..332ea80 100644
--- a/src/util/dzl-cairo.h
+++ b/src/util/dzl-cairo.h
@@ -38,6 +38,8 @@ void dzl_cairo_rounded_rectangle (cairo_t *c
* @rect: the cairo rectangle to find the right side of
*
* Finds the X coordinate of the right side of a rectangle.
+ *
+ * Returns: The X coordinate as an integer
*/
static inline gint
dzl_cairo_rectangle_x2 (const cairo_rectangle_int_t *rect)
@@ -50,6 +52,8 @@ dzl_cairo_rectangle_x2 (const cairo_rectangle_int_t *rect)
* @rect: the cairo rectangle to find the bottom of
*
* Finds the Y coordinate of the bottom of a rectangle.
+ *
+ * Returns: The Y coordinate as an integer
*/
static inline gint
dzl_cairo_rectangle_y2 (const cairo_rectangle_int_t *rect)
@@ -62,6 +66,8 @@ dzl_cairo_rectangle_y2 (const cairo_rectangle_int_t *rect)
* @rect: the cairo rectangle to find the center of
*
* Finds the X coordinate of the center of a rectangle.
+ *
+ * Returns: The X coordinate as an integer
*/
static inline gint
dzl_cairo_rectangle_center (const cairo_rectangle_int_t *rect)
@@ -74,6 +80,8 @@ dzl_cairo_rectangle_center (const cairo_rectangle_int_t *rect)
* @rect: the cairo rectangle to find the center of
*
* Finds the Y coordinate of the center of a rectangle.
+ *
+ * Returns: The Y coordinate as an integer
*/
static inline gint
dzl_cairo_rectangle_middle (const cairo_rectangle_int_t *rect)
@@ -88,6 +96,8 @@ dzl_cairo_rectangle_middle (const cairo_rectangle_int_t *rect)
*
* Determines whether rectangle @a completely contains rectangle @b.
* @b may share edges with @a and still be considered contained.
+ *
+ * Returns: Whether @a contains @b
*/
static inline cairo_bool_t
dzl_cairo_rectangle_contains_rectangle (const cairo_rectangle_int_t *a,
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]