From 90a4e33415ee3b008c2873519e94f61a059b9475 Mon Sep 17 00:00:00 2001
From: Emmanuele Bassi <ebassi@gnome.org>
Date: Thu, 21 Dec 2017 19:07:02 +0000
Subject: Update annotations for GdkEvent API

The GdkEvent API is missing some gtk-doc stanzas, as well as some
introspection annotations.
---
 gdk/gdkevents.c | 24 +++++++++++++++++++++---
 1 file changed, 21 insertions(+), 3 deletions(-)

(limited to 'gdk')

diff --git a/gdk/gdkevents.c b/gdk/gdkevents.c
index fb773f5592..9bd6cfe2e5 100644
--- a/gdk/gdkevents.c
+++ b/gdk/gdkevents.c
@@ -601,9 +601,9 @@ copy_time_coord (const GdkTimeCoord *coord)
  * Copies a #GdkEvent, copying or incrementing the reference count of the
  * resources associated with it (e.g. #GdkWindow’s and strings).
  * 
- * Returns: a copy of @event. The returned #GdkEvent should be freed with
- * gdk_event_free().
- **/
+ * Returns: (transfer full): a copy of @event. The returned #GdkEvent should
+ *   be freed with gdk_event_free().
+ */
 GdkEvent*
 gdk_event_copy (const GdkEvent *event)
 {
@@ -1848,6 +1848,14 @@ gdk_event_set_display (GdkEvent   *event,
   event->any.display = display;
 }
 
+/**
+ * gdk_event_get_display:
+ * @event: a #GdkEvent
+ *
+ * Retrieves the #GdkDisplay associated to the @event.
+ *
+ * Returns: (transfer none) (nullable): a #GdkDisplay
+ */
 GdkDisplay *
 gdk_event_get_display (const GdkEvent *event)
 {
@@ -2495,6 +2503,16 @@ gdk_event_get_axes (GdkEvent  *event,
   return FALSE;
 }
 
+/**
+ * gdk_event_get_history:
+ * @event: a #GdkEvent of type %GDK_MOTION_NOTIFY
+ *
+ * Retrieves the history of the @event motion, as a list of time and
+ * coordinates.
+ *
+ * Returns: (transfer container) (element-type GdkTimeCoord) (nullable): a list
+ *   of time and coordinates
+ */
 GList *
 gdk_event_get_history (const GdkEvent *event)
 {
-- 
cgit v1.2.1