[gtk] gdk: Documentation improvements



commit f6225901e8e85cc444f4b191d36274ae2d87a825
Author: Matthias Clasen <mclasen redhat com>
Date:   Thu May 2 02:39:36 2019 +0000

    gdk: Documentation improvements
    
    Document some new x11 symbols.

 docs/reference/gdk/gdk4-sections.txt |  2 +-
 gdk/x11/gdksurface-x11.c             | 20 ++++++++++++++++----
 2 files changed, 17 insertions(+), 5 deletions(-)
---
diff --git a/docs/reference/gdk/gdk4-sections.txt b/docs/reference/gdk/gdk4-sections.txt
index 2a9afa8110..8eb27f7c89 100644
--- a/docs/reference/gdk/gdk4-sections.txt
+++ b/docs/reference/gdk/gdk4-sections.txt
@@ -231,6 +231,7 @@ gdk_surface_get_scale_factor
 gdk_surface_set_opaque_region
 gdk_surface_create_gl_context
 gdk_surface_create_vulkan_context
+gdk_surface_create_cairo_context
 
 <SUBSECTION>
 gdk_surface_queue_expose
@@ -988,7 +989,6 @@ gdk_wayland_device_get_wl_seat
 gdk_wayland_display_get_wl_compositor
 gdk_wayland_display_get_wl_display
 gdk_wayland_display_query_registry
-gdk_wayland_surface_new_subsurface
 gdk_wayland_surface_get_wl_surface
 GdkWaylandSurfaceExported
 gdk_wayland_surface_export_handle
diff --git a/gdk/x11/gdksurface-x11.c b/gdk/x11/gdksurface-x11.c
index 4da000c596..9dfeb06703 100644
--- a/gdk/x11/gdksurface-x11.c
+++ b/gdk/x11/gdksurface-x11.c
@@ -1870,7 +1870,10 @@ gdk_x11_surface_set_modal_hint (GdkSurface *surface,
 /**
  * gdk_x11_surface_set_skip_taskbar_hint:
  * @surface: (type GdkX11Surface): a native #GdkSurface
- * @skips_taskbar:
+ * @skips_taskbar: %TRUE to skip taskbars
+ *
+ * Sets a hint on @surface that taskbars should not
+ * display it. See the EWMH for details.
  */
 void
 gdk_x11_surface_set_skip_taskbar_hint (GdkSurface *surface,
@@ -1895,8 +1898,11 @@ gdk_x11_surface_set_skip_taskbar_hint (GdkSurface *surface,
 
 /**
  * gdk_x11_surface_set_skip_pager_hint:
- * @surface: (type GdkX11Surface): a native #GdkSurface
- * @skips_pager:
+ * @surface: (type GdkX11Surface): a #GdkSurface
+ * @skips_pager: %TRUE to skip pagers
+ *
+ * Sets a hint on @surface that pagers should not
+ * display it. See the EWMH for details.
  */
 void
 gdk_x11_surface_set_skip_pager_hint (GdkSurface *surface,
@@ -1922,7 +1928,10 @@ gdk_x11_surface_set_skip_pager_hint (GdkSurface *surface,
 /**
  * gdk_x11_surface_set_urgency_hint:
  * @surface: (type GdkX11Surface): a native #GdkSurface
- * @urgent:
+ * @urgent: %TRUE to indicate urgenct attention needed
+ *
+ * Sets a hint on @surface that it needs user attention.
+ * See the ICCCM for details.
  */
 void
 gdk_x11_surface_set_urgency_hint (GdkSurface *surface,
@@ -3396,6 +3405,9 @@ gdk_x11_surface_get_group (GdkSurface *surface)
  * gdk_x11_surface_set_group:
  * @surface: (type GdkX11Surface): a native #GdkSurface
  * @leader: a #GdkSurface
+ *
+ * Sets the group leader of @surface to be @leader.
+ * See the ICCCM for details.
  */
 void
 gdk_x11_surface_set_group (GdkSurface *surface,


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