From 537576e0b44dc28ecd5adeed991a32d9b516c2bc Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Mon, 8 Dec 2008 01:46:43 +0000 Subject: [PATCH] Correct the documentation. Patch by Paul Davis * gdk/gdkdisplay.c (gdk_display_get_window_at_pointer): Correct the documentation. Patch by Paul Davis svn path=/trunk/; revision=21852 --- ChangeLog | 8 ++++++++ gdk/gdkdisplay.c | 12 +++++++----- 2 files changed, 15 insertions(+), 5 deletions(-) diff --git a/ChangeLog b/ChangeLog index d4e0f12549..4ee30d116d 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,11 @@ +2008-12-07 Matthias Clasen + + Bug 559325 – documentation for gdk_display_get_window_at_pointer() + is wrong + + * gdk/gdkdisplay.c (gdk_display_get_window_at_pointer): Correct + the documentation. Patch by Paul Davis + 2008-12-07 Matthias Clasen Bug 563285 – test print backend does not compile diff --git a/gdk/gdkdisplay.c b/gdk/gdkdisplay.c index 2b163de635..9417c4e947 100644 --- a/gdk/gdkdisplay.c +++ b/gdk/gdkdisplay.c @@ -476,13 +476,15 @@ gdk_display_get_pointer (GdkDisplay *display, /** * gdk_display_get_window_at_pointer: * @display: a #GdkDisplay - * @win_x: return location for origin of the window under the pointer - * @win_y: return location for origin of the window under the pointer + * @win_x: return location for x coordinate of the pointer location relative + * to the window origin, or %NULL + * @win_y: return location for y coordinate of the pointer location relative + & to the window origin, or %NULL * * Obtains the window underneath the mouse pointer, returning the location - * of that window in @win_x, @win_y for @screen. Returns %NULL if the window - * under the mouse pointer is not known to GDK (for example, belongs to - * another application). + * of the pointer in that window in @win_x, @win_y for @screen. Returns %NULL + * if the window under the mouse pointer is not known to GDK (for example, + * belongs to another application). * * Returns: the window under the mouse pointer, or %NULL *