From 4a11baa37286ae9b03d213b59afb2e729d7d78b6 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Mon, 4 Dec 2017 23:52:48 -0800 Subject: [PATCH] gdk: Documentation improvements --- docs/reference/gdk/gdk4-sections.txt | 22 ++++++++++++++-------- docs/reference/gdk/meson.build | 9 ++++++--- gdk/gdkclipboard.c | 22 +++++++++++----------- gdk/gdkclipboard.h | 6 +++--- gdk/gdkcontentprovider.c | 2 +- gdk/wayland/gdkdevice-wayland.c | 2 +- 6 files changed, 36 insertions(+), 27 deletions(-) diff --git a/docs/reference/gdk/gdk4-sections.txt b/docs/reference/gdk/gdk4-sections.txt index 7374259daa..bd5d05d9a1 100644 --- a/docs/reference/gdk/gdk4-sections.txt +++ b/docs/reference/gdk/gdk4-sections.txt @@ -104,6 +104,9 @@ gdk_display_get_monitor gdk_display_get_primary_monitor gdk_display_get_monitor_at_point gdk_display_get_monitor_at_window +gdk_display_get_clipboard +gdk_display_get_primary_clipboard +gdk_display_get_setting GDK_DISPLAY @@ -174,7 +177,7 @@ gdk_rgba_get_type windows GdkWindow GdkWindowType -GdkWindowWindowClass +GdkWindowClass GdkWindowHints GdkGeometry GdkGravity @@ -379,7 +382,7 @@ gdk_content_formats_get_mime_types gdk_content_formats_union gdk_content_formats_match gdk_content_formats_match_gtype -gdk_content_formats_match_mime_types +gdk_content_formats_match_mime_type gdk_content_formats_contain_gtype gdk_content_formats_contain_mime_type @@ -398,6 +401,8 @@ gdk_content_formats_builder_add_gtype gdk_content_formats_builder_add_mime_type +GDK_TYPE_FILE_LIST +gdk_file_list_get_type gdk_content_formats_get_type @@ -783,7 +788,6 @@ GdkCrossingMode GdkNotifyType GdkPropertyState GdkWindowState -GdkOwnerChange GDK_TYPE_CROSSING_MODE @@ -804,17 +808,19 @@ gdk_owner_change_get_type textures GdkTexture gdk_texture_new_for_data -gdk_texture_new_for_surface gdk_texture_new_for_pixbuf gdk_texture_new_from_resource gdk_texture_new_from_file gdk_texture_get_width gdk_texture_get_height gdk_texture_download + +GdkTextureClass gdk_texture_get_type GDK_TYPE_TEXTURE GDK_IS_TEXTURE +GDK_TEXTURE
@@ -823,7 +829,6 @@ GDK_IS_TEXTURE GdkCursor gdk_cursor_new_from_texture gdk_cursor_new_from_name -gdk_cursor_get_display gdk_cursor_get_fallback gdk_cursor_get_name gdk_cursor_get_texture @@ -850,7 +855,6 @@ gdk_drag_begin gdk_drag_begin_for_device gdk_drag_begin_from_point gdk_drop_finish -GdkDragProtocol GdkDragAction gdk_drag_status gdk_drag_drop_succeeded @@ -925,7 +929,6 @@ gdk_x11_screen_get_current_desktop gdk_x11_window_foreign_new_for_display gdk_x11_window_lookup_for_display gdk_x11_window_get_xid -gdk_x11_window_set_hide_titlebar_when_maximized gdk_x11_window_set_theme_variant gdk_x11_window_set_user_time gdk_x11_window_move_to_current_desktop @@ -1066,7 +1069,6 @@ gdk_wayland_device_get_wl_pointer gdk_wayland_device_get_wl_seat gdk_wayland_display_get_wl_compositor gdk_wayland_display_get_wl_display -gdk_wayland_display_get_xdg_shell gdk_wayland_window_new_subsurface gdk_wayland_window_get_wl_surface gdk_wayland_window_set_use_custom_surface @@ -1253,6 +1255,7 @@ gdk_drawing_context_get_window gdk_drawing_context_get_clip gdk_drawing_context_get_cairo_context gdk_drawing_context_is_valid +gdk_drawing_context_get_paint_context gdk_drawing_context_get_type @@ -1265,6 +1268,7 @@ GDK_IS_DRAWING_CONTEXT
gdkvulkancontext GdkVulkanContext +GdkVulkanError gdk_vulkan_context_get_device gdk_vulkan_context_get_draw_index gdk_vulkan_context_get_draw_semaphore @@ -1323,6 +1327,7 @@ gdk_content_provider_write_mime_type_finish gdk_content_provider_get_value +GdkContentProviderClass gdk_content_provider_get_type
@@ -1351,6 +1356,7 @@ gdk_content_serialize_finish GDK_TYPE_CONTENT_SERIALIZER GDK_CONTENT_SERIALIZER GDK_IS_CONTENT_SERIALIZER +gdk_content_serializer_get_type
diff --git a/docs/reference/gdk/meson.build b/docs/reference/gdk/meson.build index 0e6d8ff404..22b9a509bb 100644 --- a/docs/reference/gdk/meson.build +++ b/docs/reference/gdk/meson.build @@ -6,6 +6,9 @@ private_headers = [ 'gdkprivate.h', 'gdk-private.h', 'gdkapplaunchcontextprivate.h', + 'gdkclipboardprivate.h', + 'gdkcontentformatsprivate.h', + 'gdkcontentproviderprivate.h', 'gdkcursorprivate.h', 'gdkdeviceprivate.h', 'gdkdisplaymanagerprivate.h', @@ -16,17 +19,17 @@ private_headers = [ 'gdkglcontextprivate.h', 'gdkkeysprivate.h', 'gdkmonitorprivate.h', + 'gdkpipeiostreamprivate.h', 'gdkscreenprivate.h', 'gdkseatdefaultprivate.h', 'gdkseatprivate.h', + 'gdktextureprivate.h', 'gdkvisualprivate.h', 'gdkvulkancontextprivate.h', 'keyname-table.h', 'win32', - 'x11', 'quartz', - 'broadway', - 'wayland', + 'broadway' ] images = [ diff --git a/gdk/gdkclipboard.c b/gdk/gdkclipboard.c index befbb08aef..61f24bf7a9 100644 --- a/gdk/gdkclipboard.c +++ b/gdk/gdkclipboard.c @@ -874,14 +874,14 @@ gdk_clipboard_read_value_async (GdkClipboard *clipboard, **/ const GValue * gdk_clipboard_read_value_finish (GdkClipboard *clipboard, - GAsyncResult *res, + GAsyncResult *result, GError **error) { - g_return_val_if_fail (g_task_is_valid (res, clipboard), NULL); - g_return_val_if_fail (g_task_get_source_tag (G_TASK (res)) == gdk_clipboard_read_value_async, NULL); + g_return_val_if_fail (g_task_is_valid (result, clipboard), NULL); + g_return_val_if_fail (g_task_get_source_tag (G_TASK (result)) == gdk_clipboard_read_value_async, NULL); g_return_val_if_fail (error == NULL || *error == NULL, NULL); - return g_task_propagate_pointer (G_TASK (res), error); + return g_task_propagate_pointer (G_TASK (result), error); } /** @@ -932,16 +932,16 @@ gdk_clipboard_read_texture_async (GdkClipboard *clipboard, **/ GdkTexture * gdk_clipboard_read_texture_finish (GdkClipboard *clipboard, - GAsyncResult *res, + GAsyncResult *result, GError **error) { const GValue *value; - g_return_val_if_fail (g_task_is_valid (res, clipboard), NULL); - g_return_val_if_fail (g_task_get_source_tag (G_TASK (res)) == gdk_clipboard_read_texture_async, NULL); + g_return_val_if_fail (g_task_is_valid (result, clipboard), NULL); + g_return_val_if_fail (g_task_get_source_tag (G_TASK (result)) == gdk_clipboard_read_texture_async, NULL); g_return_val_if_fail (error == NULL || *error == NULL, NULL); - value = g_task_propagate_pointer (G_TASK (res), error); + value = g_task_propagate_pointer (G_TASK (result), error); if (!value) return NULL; @@ -996,16 +996,16 @@ gdk_clipboard_read_text_async (GdkClipboard *clipboard, **/ char * gdk_clipboard_read_text_finish (GdkClipboard *clipboard, - GAsyncResult *res, + GAsyncResult *result, GError **error) { const GValue *value; - g_return_val_if_fail (g_task_is_valid (res, clipboard), NULL); + g_return_val_if_fail (g_task_is_valid (result, clipboard), NULL); g_return_val_if_fail (g_task_get_source_tag (G_TASK (res)) == gdk_clipboard_read_text_async, NULL); g_return_val_if_fail (error == NULL || *error == NULL, NULL); - value = g_task_propagate_pointer (G_TASK (res), error); + value = g_task_propagate_pointer (G_TASK (result), error); if (!value) return NULL; diff --git a/gdk/gdkclipboard.h b/gdk/gdkclipboard.h index 4f338b323b..2733f65e03 100644 --- a/gdk/gdkclipboard.h +++ b/gdk/gdkclipboard.h @@ -78,7 +78,7 @@ void gdk_clipboard_read_value_async (GdkClipboard * gpointer user_data); GDK_AVAILABLE_IN_3_94 const GValue * gdk_clipboard_read_value_finish (GdkClipboard *clipboard, - GAsyncResult *res, + GAsyncResult *result, GError **error); GDK_AVAILABLE_IN_3_94 void gdk_clipboard_read_texture_async(GdkClipboard *clipboard, @@ -87,7 +87,7 @@ void gdk_clipboard_read_texture_async(GdkClipboard * gpointer user_data); GDK_AVAILABLE_IN_3_94 GdkTexture * gdk_clipboard_read_texture_finish (GdkClipboard *clipboard, - GAsyncResult *res, + GAsyncResult *result, GError **error); GDK_AVAILABLE_IN_3_94 void gdk_clipboard_read_text_async (GdkClipboard *clipboard, @@ -96,7 +96,7 @@ void gdk_clipboard_read_text_async (GdkClipboard * gpointer user_data); GDK_AVAILABLE_IN_3_94 char * gdk_clipboard_read_text_finish (GdkClipboard *clipboard, - GAsyncResult *res, + GAsyncResult *result, GError **error); GDK_AVAILABLE_IN_3_94 diff --git a/gdk/gdkcontentprovider.c b/gdk/gdkcontentprovider.c index 15ffb93931..ee474883d1 100644 --- a/gdk/gdkcontentprovider.c +++ b/gdk/gdkcontentprovider.c @@ -280,7 +280,7 @@ gdk_content_provider_content_changed (GdkContentProvider *provider) /** * gdk_content_provider_write_mime_type_async: * @provider: a #GdkContentProvider - * @type: the #GType to provide the data in + * @mime_type: the mime type to provide the data in * @stream: the #GOutputStream to write to * @io_priority: the [I/O priority][io-priority] * of the request. diff --git a/gdk/wayland/gdkdevice-wayland.c b/gdk/wayland/gdkdevice-wayland.c index 4f0641f226..5b067bfa77 100644 --- a/gdk/wayland/gdkdevice-wayland.c +++ b/gdk/wayland/gdkdevice-wayland.c @@ -4974,7 +4974,7 @@ gdk_wayland_device_set_selection (GdkDevice *gdk_device, /** * gdk_wayland_seat_get_wl_seat: - * @device: (type GdkWaylandDevice): a #GdkDevice + * @seat: (type GdkWaylandSeat): a #GdkSeat * * Returns the Wayland wl_seat of a #GdkSeat. *