Permalink
Browse files

Add annotations so that methods are properly paired to objects.

Add type annotations to 1st argument of gdk_x11_* functions so that they are
properly recognized as methods of GdkX11 objects.

https://bugzilla.gnome.org/show_bug.cgi?id=655496
  • Loading branch information...
1 parent 0893a3f commit 21a5b038a7104bda778d8d7c2724f460e7929c9d Pavel Holejsovsky committed Jul 28, 2011
View
@@ -286,7 +286,7 @@ _gdk_x11_display_get_cursor_for_type (GdkDisplay *display,
/**
* gdk_x11_cursor_get_xdisplay:
- * @cursor: a #GdkCursor.
+ * @cursor: (type GdkX11Cursor): a #GdkCursor.
*
* Returns the display of a #GdkCursor.
*
@@ -302,7 +302,7 @@ gdk_x11_cursor_get_xdisplay (GdkCursor *cursor)
/**
* gdk_x11_cursor_get_xcursor:
- * @cursor: a #GdkCursor.
+ * @cursor: (type GdkX11Cursor): a #GdkCursor.
*
* Returns the X cursor belonging to a #GdkCursor.
*
@@ -435,7 +435,7 @@ update_cursor (gpointer data,
/**
* gdk_x11_display_set_cursor_theme:
- * @display: a #GdkDisplay
+ * @display: (type GdkX11Display): a #GdkDisplay
* @theme: the name of the cursor theme to use, or %NULL to unset
* a previously set value
* @size: the cursor size to use, or 0 to keep the previous size
View
@@ -1635,7 +1635,7 @@ gdk_x11_display_get_default_group (GdkDisplay *display)
/**
* gdk_x11_display_grab:
- * @display: a #GdkDisplay
+ * @display: (type GdkX11Display): a #GdkDisplay
*
* Call XGrabServer() on @display.
* To ungrab the display again, use gdk_x11_display_ungrab().
@@ -1660,7 +1660,7 @@ gdk_x11_display_grab (GdkDisplay *display)
/**
* gdk_x11_display_ungrab:
- * @display: a #GdkDisplay
+ * @display: (type GdkX11Display): a #GdkDisplay
*
* Ungrab @display after it has been grabbed with
* gdk_x11_display_grab().
@@ -1844,7 +1844,7 @@ _gdk_x11_display_screen_for_xrootwin (GdkDisplay *display,
/**
* gdk_x11_display_get_xdisplay:
- * @display: a #GdkDisplay
+ * @display: (type GdkX11Display): a #GdkDisplay
* @returns: (transfer none): an X display.
*
* Returns the X display of a #GdkDisplay.
@@ -1975,7 +1975,7 @@ broadcast_xmessage (GdkDisplay *display,
/**
* gdk_x11_display_broadcast_startup_message:
- * @display: a #GdkDisplay
+ * @display: (type GdkX11Display): a #GdkDisplay
* @message_type: startup notification message type ("new", "change",
* or "remove")
* @...: a list of key/value pairs (as strings), terminated by a
@@ -2148,7 +2148,7 @@ gdk_x11_display_store_clipboard (GdkDisplay *display,
/**
* gdk_x11_display_get_user_time:
- * @display: a #GdkDisplay
+ * @display: (type GdkX11Display): a #GdkDisplay
*
* Returns the timestamp of the last user interaction on
* @display. The timestamp is taken from events caused
@@ -2180,7 +2180,7 @@ gdk_x11_display_supports_input_shapes (GdkDisplay *display)
/**
* gdk_x11_display_get_startup_notification_id:
- * @display: a #GdkDisplay
+ * @display: (type GdkX11Display): a #GdkDisplay
*
* Gets the startup notification ID for a display.
*
@@ -2196,7 +2196,7 @@ gdk_x11_display_get_startup_notification_id (GdkDisplay *display)
/**
* gdk_x11_display_set_startup_notification_id:
- * @display: a #GdkDisplay
+ * @display: (type GdkX11Display): a #GdkDisplay
* @startup_id: the startup notification ID (must be valid utf8)
*
* Sets the startup notification ID for a display.
@@ -2412,7 +2412,7 @@ delete_outdated_error_traps (GdkX11Display *display_x11)
/**
* gdk_x11_display_error_trap_push:
- * @display: a #GdkDisplay
+ * @display: (type GdkX11Display): a #GdkDisplay
*
* Begins a range of X requests on @display for which X error events
* will be ignored. Unignored errors (when no trap is pushed) will abort
@@ -2517,7 +2517,7 @@ gdk_x11_display_error_trap_pop_internal (GdkDisplay *display,
/**
* gdk_x11_display_error_trap_pop:
- * @display: the display
+ * @display: (type GdkX11Display): the display
*
* Pops the error trap pushed by gdk_x11_display_error_trap_push().
* Will XSync() if necessary and will always block until
@@ -2544,7 +2544,7 @@ gdk_x11_display_error_trap_pop (GdkDisplay *display)
/**
* gdk_x11_display_error_trap_pop_ignored:
- * @display: the display
+ * @display: (type GdkX11Display): the display
*
* Pops the error trap pushed by gdk_x11_display_error_trap_push().
* Does not block to see if an error occurred; merely records the
View
@@ -266,7 +266,7 @@ gdk_x11_screen_get_monitor_plug_name (GdkScreen *screen,
/**
* gdk_x11_screen_get_monitor_output:
- * @screen: a #GdkScreen
+ * @screen: (type GdkX11Screen): a #GdkScreen
* @monitor_num: number of the monitor, between 0 and gdk_screen_get_n_monitors (screen)
*
* Gets the XID of the specified output/monitor.
@@ -319,7 +319,7 @@ gdk_x11_screen_get_rgba_visual (GdkScreen *screen)
/**
* gdk_x11_screen_get_xscreen:
- * @screen: a #GdkScreen.
+ * @screen: (type GdkX11Screen): a #GdkScreen.
* @returns: (transfer none): an Xlib <type>Screen*</type>
*
* Returns the screen of a #GdkScreen.
@@ -334,7 +334,7 @@ gdk_x11_screen_get_xscreen (GdkScreen *screen)
/**
* gdk_x11_screen_get_screen_number:
- * @screen: a #GdkScreen.
+ * @screen: (type GdkX11Screen): a #GdkScreen.
* @returns: the position of @screen among the screens of
* its display.
*
@@ -1275,7 +1275,7 @@ fetch_net_wm_check_window (GdkScreen *screen)
/**
* gdk_x11_screen_supports_net_wm_hint:
- * @screen: the relevant #GdkScreen.
+ * @screen: (type GdkX11Screen): the relevant #GdkScreen.
* @property: a property atom.
*
* This function is specific to the X11 backend of GDK, and indicates
@@ -1510,7 +1510,7 @@ _gdk_x11_screen_init_events (GdkScreen *screen)
/**
* gdk_x11_screen_get_window_manager_name:
- * @screen: a #GdkScreen
+ * @screen: (type GdkX11Screen): a #GdkScreen
*
* Returns the name of the window manager for @screen.
*
@@ -333,7 +333,7 @@ _gdk_x11_display_send_selection_notify (GdkDisplay *display,
/**
* gdk_x11_display_text_property_to_text_list:
- * @display: The #GdkDisplay where the encoding is defined
+ * @display: (type GdkX11Display): The #GdkDisplay where the encoding is defined
* @encoding: an atom representing the encoding. The most
* common values for this are STRING, or COMPOUND_TEXT.
* This is value used as the type for the property
@@ -574,7 +574,7 @@ _gdk_x11_display_text_property_to_utf8_list (GdkDisplay *display,
/**
* gdk_x11_display_string_to_compound_text:
- * @display: the #GdkDisplay where the encoding is defined
+ * @display: (type GdkX11Display): the #GdkDisplay where the encoding is defined
* @str: a nul-terminated string
* @encoding: (out) (transfer none): location to store the encoding atom
* (to be used as the type for the property)
@@ -695,7 +695,7 @@ _gdk_x11_display_utf8_to_string_target (GdkDisplay *display,
/**
* gdk_x11_display_utf8_to_compound_text:
- * @display: a #GdkDisplay
+ * @display: (type GdkX11Display): a #GdkDisplay
* @str: a UTF-8 string
* @encoding: (out): location to store resulting encoding
* @format: (out): location to store format of the result
View
@@ -457,7 +457,7 @@ _gdk_x11_screen_list_visuals (GdkScreen *screen)
/**
* gdk_x11_screen_lookup_visual:
- * @screen: a #GdkScreen.
+ * @screen: (type GdkX11Screen): a #GdkScreen.
* @xvisualid: an X Visual ID.
*
* Looks up the #GdkVisual for a particular screen and X Visual ID.
View
@@ -1699,7 +1699,7 @@ gdk_window_x11_lower (GdkWindow *window)
/**
* gdk_x11_window_move_to_current_desktop:
- * @window: a #GdkWindow
+ * @window: (type GdkX11Window): a #GdkWindow
*
* Moves the window to the correct workspace when running under a
* window manager that supports multiple workspaces, as described
@@ -3023,7 +3023,7 @@ gdk_x11_window_set_focus_on_map (GdkWindow *window,
/**
* gdk_x11_window_set_user_time:
- * @window: A toplevel #GdkWindow
+ * @window: (type GdkX11Window): A toplevel #GdkWindow
* @timestamp: An XServer timestamp to which the property should be set
*
* The application can use this call to update the _NET_WM_USER_TIME
@@ -3088,7 +3088,7 @@ gdk_x11_window_set_user_time (GdkWindow *window,
/**
* gdk_x11_window_set_theme_variant:
- * @window: a #GdkWindow
+ * @window: (type GdkX11Window): a #GdkWindow
* @variant: the theme variant to export
*
* GTK+ applications can request a dark theme variant. In order to
@@ -4701,9 +4701,10 @@ timestamp_predicate (Display *display,
/**
* gdk_x11_get_server_time:
- * @window: a #GdkWindow, used for communication with the server.
- * The window must have GDK_PROPERTY_CHANGE_MASK in its
- * events mask or a hang will result.
+ * @window: (type GdkX11Window): a #GdkWindow, used for communication
+ * with the server. The window must have
+ * GDK_PROPERTY_CHANGE_MASK in its events mask or a hang will
+ * result.
*
* Routine to get the current X server time stamp.
*
@@ -4739,7 +4740,7 @@ gdk_x11_get_server_time (GdkWindow *window)
/**
* gdk_x11_window_get_xid:
- * @window: a native #GdkWindow.
+ * @window: (type GdkX11Window): a native #GdkWindow.
*
* Returns the X resource (window) belonging to a #GdkWindow.
*
View
@@ -81,7 +81,8 @@ _gdk_x11_display_remove_window (GdkDisplay *display,
/**
* gdk_x11_window_lookup_for_display:
- * @display: the #GdkDisplay corresponding to the window handle
+ * @display: (type GdkX11Window): the #GdkDisplay corresponding to the
+ * window handle
* @window: an XLib <type>Window</type>
*
* Looks up the #GdkWindow that wraps the given native window handle.

0 comments on commit 21a5b03

Please sign in to comment.