[gtk/matthiasc/for-main] gdk: Improve GdkTimeCoord docs




commit c76069389c8e83af665be676712ef29cb344ddcc
Author: Matthias Clasen <mclasen redhat com>
Date:   Mon Jun 6 08:55:51 2022 -0400

    gdk: Improve GdkTimeCoord docs

 gdk/gdkdevice.h | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)
---
diff --git a/gdk/gdkdevice.h b/gdk/gdkdevice.h
index cf329499a4..c24c084631 100644
--- a/gdk/gdkdevice.h
+++ b/gdk/gdkdevice.h
@@ -66,10 +66,15 @@ typedef enum
 /**
  * GdkTimeCoord:
  * @time: The timestamp for this event
- * @flags: Flags indicating what axes are present
- * @axes: (array fixed-size=12): axis values
+ * @flags: Flags indicating what axes are present, see [flags@Gdk.AxisFlags]
+ * @axes: (array fixed-size=12): axis values, indexed by [enum@Gdk.AxisUse]
  *
  * A `GdkTimeCoord` stores a single event in a motion history.
+ *
+ * To check whether an axis is present, check whether the corresponding
+ * flag from the [flags@Gdk.AxisFlags] enumeration is set in the @flags
+ * To access individual axis values, use the values of the values of
+ * the [enum@Gdk.AxisUse] enumerations as indices.
  */
 struct _GdkTimeCoord
 {


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