[gtk+] [gdkevents] Add annotations for GdkEvent getters.



commit 586d60dbeedeabcbd4c3098dadcbac5a67c33ba7
Author: Steve Frécinaux <code istique net>
Date:   Mon Jun 7 23:47:14 2010 +0200

    [gdkevents] Add annotations for GdkEvent getters.

 gdk/gdkevents.c |   18 +++++++++---------
 1 files changed, 9 insertions(+), 9 deletions(-)
---
diff --git a/gdk/gdkevents.c b/gdk/gdkevents.c
index 151ce86..e073115 100644
--- a/gdk/gdkevents.c
+++ b/gdk/gdkevents.c
@@ -647,7 +647,7 @@ gdk_event_get_time (const GdkEvent *event)
 /**
  * gdk_event_get_state:
  * @event: a #GdkEvent or NULL
- * @state: return location for state
+ * @state: (out): return location for state
  * 
  * If the event contains a "state" field, puts that field in @state. Otherwise
  * stores an empty state (0). Returns %TRUE if there was a state field
@@ -727,8 +727,8 @@ gdk_event_get_state (const GdkEvent        *event,
 /**
  * gdk_event_get_coords:
  * @event: a #GdkEvent
- * @x_win: location to put event window x coordinate
- * @y_win: location to put event window y coordinate
+ * @x_win: (out): location to put event window x coordinate
+ * @y_win: (out): location to put event window y coordinate
  * 
  * Extract the event window relative x/y coordinates from an event.
  * 
@@ -786,8 +786,8 @@ gdk_event_get_coords (const GdkEvent *event,
 /**
  * gdk_event_get_root_coords:
  * @event: a #GdkEvent
- * @x_root: location to put root window x coordinate
- * @y_root: location to put root window y coordinate
+ * @x_root: (out): location to put root window x coordinate
+ * @y_root: (out): location to put root window y coordinate
  * 
  * Extract the root window relative x/y coordinates from an event.
  * 
@@ -850,8 +850,8 @@ gdk_event_get_root_coords (const GdkEvent *event,
 /**
  * gdk_event_get_axis:
  * @event: a #GdkEvent
- * @axis_use: the axis use to look for
- * @value: location to store the value found
+ * @axis_use: (out): the axis use to look for
+ * @value: (out): location to store the value found
  * 
  * Extract the axis value for a particular axis use from
  * an event structure.
@@ -1149,8 +1149,8 @@ gdk_events_get_angle (GdkEvent *event1,
  * gdk_events_get_center:
  * @event1: first #GdkEvent
  * @event2: second #GdkEvent
- * @x: return location for the X coordinate of the center
- * @y: return location for the Y coordinate of the center
+ * @x: (out): return location for the X coordinate of the center
+ * @y: (out): return location for the Y coordinate of the center
  *
  * If both events contain X/Y information, the center of both coordinates
  * will be returned in @x and @y.



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