From: Marc-André Lureau <marcandre.lureau@redhat.com>
Date: Tue, 23 Aug 2022 13:06:48 +0000 (+0400)
Subject: gdk/win32: annotate gdk_win32_surface_set_urgency_hint
X-Git-Tag: archive/raspbian/4.8.3+ds-2+rpi1~3^2~20^2~3^2~58^2~1
X-Git-Url: https://dgit.raspbian.org/?a=commitdiff_plain;h=cad32636cec29de26701af5adaecd09285effced;p=gtk4.git

gdk/win32: annotate gdk_win32_surface_set_urgency_hint

Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
---

diff --git a/gdk/win32/gdksurface-win32.c b/gdk/win32/gdksurface-win32.c
index ed19c9f70a..a2f60eb3ec 100644
--- a/gdk/win32/gdksurface-win32.c
+++ b/gdk/win32/gdksurface-win32.c
@@ -1305,19 +1305,27 @@ gdk_win32_surface_raise (GdkSurface *window)
     }
 }
 
+/**
+ * gdk_win32_surface_set_urgency_hint:
+ * @surface: (type GdkWin32Surface): a native `GdkSurface`.
+ * @urgent: if %TRUE, flashes both the window and the taskbar button
+ *          continuously.
+ *
+ * Flashes the specified @surface.
+ */
 void
-gdk_win32_surface_set_urgency_hint (GdkSurface *window,
+gdk_win32_surface_set_urgency_hint (GdkSurface *surface,
                                     gboolean    urgent)
 {
   FLASHWINFO flashwinfo;
 
-  g_return_if_fail (GDK_IS_SURFACE (window));
+  g_return_if_fail (GDK_IS_WIN32_SURFACE (surface));
 
-  if (GDK_SURFACE_DESTROYED (window))
+  if (GDK_SURFACE_DESTROYED (surface))
     return;
 
   flashwinfo.cbSize = sizeof (flashwinfo);
-  flashwinfo.hwnd = GDK_SURFACE_HWND (window);
+  flashwinfo.hwnd = GDK_SURFACE_HWND (surface);
   if (urgent)
     flashwinfo.dwFlags = FLASHW_ALL | FLASHW_TIMER;
   else