gdk/win32: annotate gdk_win32_surface_set_urgency_hint
authorMarc-André Lureau <marcandre.lureau@redhat.com>
Tue, 23 Aug 2022 13:06:48 +0000 (17:06 +0400)
committerMarc-André Lureau <marcandre.lureau@redhat.com>
Tue, 23 Aug 2022 13:06:48 +0000 (17:06 +0400)
Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
gdk/win32/gdksurface-win32.c

index ed19c9f70a720c9cff331c21ce9cd132f20ebdfd..a2f60eb3ecb675f9a71c3d855b00ec4c939cb36f 100644 (file)
@@ -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