Merge branch 'ebassi/doc-fixes' into 'master'

Ebassi/doc fixes Closes #3428 See merge request GNOME/gtk!2906
2025-01-01 16:30:15 +00:00 · 2020-12-02 20:08:05 +00:00 · 2020-12-02 20:08:05 +00:00 · bc4992fef9
commit bc4992fef9
parent 3da41b6021 0c8de4e561
9 changed files with 117 additions and 51 deletions
--- a/docs/reference/gdk/gdk4-sections.txt
+++ b/docs/reference/gdk/gdk4-sections.txt
@ -11,6 +11,11 @@ GDK_WINDOWING_WIN32
 GDK_WINDOWING_MACOS
 GDK_WINDOWING_WAYLAND

+<SUBSECTION>
+GDK_MAJOR_VERSION
+GDK_MICRO_VERSION
+GDK_MINOR_VERSION
+
 <SUBSECTION>
 GDK_VERSION_4_0
 GDK_VERSION_MIN_REQUIRED
@ -24,6 +29,8 @@ GDK_TYPE_GRAB_STATUS
 GDK_TYPE_STATUS
 GdkStatus
 GDKVAR
+GDK_VERSION_3_92
+GDK_VERSION_3_94
 gdk_axis_use_get_type
 gdk_byte_order_get_type
 gdk_crossing_mode_get_type
@ -827,11 +834,14 @@ gdk_x11_display_error_trap_pop_ignored
 gdk_x11_display_set_cursor_theme
 gdk_x11_display_set_surface_scale
 gdk_x11_display_get_glx_version
+gdk_x11_display_get_primary_monitor
+gdk_x11_display_get_screen
+gdk_x11_monitor_get_output
+gdk_x11_monitor_get_workarea
 gdk_x11_screen_get_screen_number
 gdk_x11_screen_get_xscreen
 gdk_x11_screen_get_window_manager_name
 gdk_x11_screen_get_monitor_output
-gdk_x11_screen_lookup_visual
 gdk_x11_screen_supports_net_wm_hint
 gdk_x11_screen_get_number_of_desktops
 gdk_x11_screen_get_current_desktop
@ -846,9 +856,9 @@ gdk_x11_surface_set_utf8_property
 gdk_x11_surface_set_frame_sync_enabled
 gdk_x11_surface_set_group
 gdk_x11_surface_get_group
-gdk_x11_keymap_get_group_for_state
-gdk_x11_keymap_key_is_modifier
-gdk_x11_visual_get_xvisual
+gdk_x11_surface_set_skip_pager_hint
+gdk_x11_surface_set_skip_taskbar_hint
+gdk_x11_surface_set_urgency_hint
 gdk_x11_get_xatom_by_name_for_display
 gdk_x11_get_xatom_name_for_display
 gdk_x11_set_sm_client_id
@ -901,29 +911,18 @@ GDK_X11_DRAG_CONTEXT_CLASS
 GDK_IS_X11_DRAG_CONTEXT
 GDK_IS_X11_DRAG_CONTEXT_CLASS
 GDK_X11_DRAG_CONTEXT_GET_CLASS
-GDK_TYPE_X11_KEYMAP
-GDK_X11_KEYMAP
-GDK_X11_KEYMAP_CLASS
-GDK_IS_X11_KEYMAP
-GDK_IS_X11_KEYMAP_CLASS
-GDK_X11_KEYMAP_GET_CLASS
 GDK_TYPE_X11_GL_CONTEXT
 GDK_X11_GL_CONTEXT
 GDK_X11_GL_CONTEXT_CLASS
 GDK_IS_X11_GL_CONTEXT
 GDK_IS_X11_GL_CONTEXT_CLASS
-GDK_TYPE_X11_SCREEN
-GDK_X11_SCREEN
-GDK_X11_SCREEN_CLASS
-GDK_IS_X11_SCREEN
-GDK_IS_X11_SCREEN_CLASS
-GDK_X11_SCREEN_GET_CLASS
-GDK_TYPE_X11_VISUAL
-GDK_X11_VISUAL
-GDK_X11_VISUAL_CLASS
-GDK_IS_X11_VISUAL
-GDK_IS_X11_VISUAL_CLASS
-GDK_X11_VISUAL_GET_CLASS
+GDK_TYPE_X11_DRAG
+GDK_X11_DRAG
+GDK_IS_X11_DRAG
+GDK_IS_X11_DRAG_CLASS
+GDK_TYPE_X11_MONITOR
+GDK_X11_MONITOR
+GDK_IS_X11_MONITOR
 GDK_TYPE_X11_SURFACE
 GDK_X11_SURFACE
 GDK_X11_SURFACE_CLASS
@ -941,9 +940,10 @@ gdk_x11_device_xi_get_type
 gdk_x11_display_get_type
 gdk_x11_display_manager_get_type
 gdk_x11_drag_context_get_type
-gdk_x11_keymap_get_type
+gdk_x11_drag_get_type
+gdk_x11_gl_context_get_type
+gdk_x11_monitor_get_type
 gdk_x11_screen_get_type
-gdk_x11_visual_get_type
 gdk_x11_surface_get_type
 gdk_surface_impl_x11_get_type
 </SECTION>
@ -958,7 +958,6 @@ gdk_wayland_display_query_registry
 gdk_wayland_display_set_cursor_theme
 gdk_wayland_display_get_startup_notification_id
 gdk_wayland_display_set_startup_notification_id
-gdk_wayland_display_query_registry

 <SUBSECTION Device>
 gdk_wayland_seat_get_wl_seat
@ -1008,8 +1007,12 @@ GDK_IS_WAYLAND_SURFACE_CLASS
 gdk_wayland_device_get_type
 gdk_wayland_display_get_type
 gdk_wayland_display_manager_get_type
+gdk_wayland_gl_context_get_type
+gdk_wayland_monitor_get_type
+gdk_wayland_popup_get_type
+gdk_wayland_seat_get_type
 gdk_wayland_surface_get_type
-
+gdk_wayland_toplevel_get_type
 </SECTION>

 <SECTION>
--- a/docs/reference/gdk/meson.build
+++ b/docs/reference/gdk/meson.build
@ -1,16 +1,16 @@
 private_headers = [
-  'gdkintl.h',
-  'gdkmarshalers.h',
-  'gdkkeysyms.h',
-  'gdkinternals.h',
+  'gdk-autocleanup.h',
  'gdk-private.h',
  'gdkapplaunchcontextprivate.h',
+  'gdkcairocontextprivate.h',
+  'gdkcairoprivate.h',
  'gdkclipboardprivate.h',
  'gdkcontentformatsprivate.h',
  'gdkcontentproviderprivate.h',
  'gdkcursorprivate.h',
-  'gdkdeviceprivate.h',
+  'gdkdebug.h',
  'gdkdevicepadprivate.h',
+  'gdkdeviceprivate.h',
  'gdkdevicetoolprivate.h',
  'gdkdisplaymanagerprivate.h',
  'gdkdisplayprivate.h',
@ -24,12 +24,17 @@ private_headers = [
  'gdkframeclockprivate.h',
  'gdkglcontextprivate.h',
  'gdkgltextureprivate.h',
+  'gdkinternals.h',
+  'gdkintl.h',
  'gdkkeysprivate.h',
-  'gdkmonitorprivate.h',
+  'gdkkeysyms.h',
+  'gdkmarshalers.h',
  'gdkmemorytextureprivate.h',
+  'gdkmonitorprivate.h',
  'gdkpipeiostreamprivate.h',
  'gdkpopupprivate.h',
  'gdkprofilerprivate.h',
+  'gdkrgbaprivate.h',
  'gdkscreenprivate.h',
  'gdkseatdefaultprivate.h',
  'gdkseatprivate.h',
@ -40,9 +45,45 @@ private_headers = [
  'gdktoplevelprivate.h',
  'gdktoplevelsizeprivate.h',
  'gdkvulkancontextprivate.h',
+  'filetransferportalprivate.h',
  'keyname-table.h',
-  'x11/gdkprivate-x11.h',
-  'x11/gdkeventsource.h',
+
+  # gdk/x11
+  'gdkcairocontext-x11.h',
+  'gdkclipboard-x11.h',
+  'gdkdevice-xi2-private.h',
+  'gdkdevicemanagerprivate-core.h',
+  'gdkdisplay-x11.h',
+  'gdkeventsource.h',
+  'gdkeventtranslator.h',
+  'gdkglcontext-x11.h',
+  'gdkkeys-x11.h',
+  'gdkmonitor-x11.h',
+  'gdkprivate-x11.h',
+  'gdkscreen-x11.h',
+  'gdkselectioninputstream-x11.h',
+  'gdkselectionoutputstream-x11.h',
+  'gdksurface-x11.h',
+  'gdktextlistconverter-x11.h',
+  'gdkvisual-x11.h',
+  'gdkvulkancontext-x11.h',
+  'gdkx-autocleanups.h',
+  'MwmUtil.h',
+  'xsettings-client.h',
+
+  # gdk/wayland
+  'gdkcairocontext-wayland.h',
+  'gdkclipboard-wayland.h',
+  'gdkdevice-wayland-private.h',
+  'gdkdisplay-wayland.h',
+  'gdkglcontext-wayland.h',
+  'gdkmonitor-wayland.h',
+  'gdkprimary-wayland.h',
+  'gdkprivate-wayland.h',
+  'gdkseat-wayland.h',
+  'gdksurface-wayland.h',
+  'gdkvulkancontext-wayland.h',
+  'wm-button-layout-translation.h',
  'gtk-primary-selection-client-protocol.h',
  'gtk-shell-client-protocol.h',
  'idle-inhibit-unstable-v1-client-protocol.h',
@ -56,10 +97,14 @@ private_headers = [
  'xdg-output-unstable-v1-client-protocol.h',
  'xdg-shell-client-protocol.h',
  'xdg-shell-unstable-v6-client-protocol.h',
-  'win32',
-  'quartz',
+  'wayland-cursor.h',
+  'os-compatibility.h',
+  'xcursor.h',
+
  'broadway',
-  'mir'
+  'wayland/cursor',
+  'macos',
+  'win32',
 ]

 images = [
@ -123,6 +168,9 @@ if get_option('gtk_doc')
                 '--ignore-decorators=_GDK_EXTERN|G_GNUC_WARN_UNUSED_RESULT',
                 '--ignore-headers=' + ' '.join(private_headers),
               ],
+               mkdb_args: [
+                 '--ignore-files=' + ' '.join(private_headers),
+               ],
               fixxref_args: [
                 '--html-dir=@0@'.format(docpath),
                 '--extra-dir=@0@'.format(join_paths(glib_docpath, 'glib')),
--- a/docs/reference/gtk/meson.build
+++ b/docs/reference/gtk/meson.build
@ -1,9 +1,6 @@
 fs = import('fs')

 private_headers = [
-  'imm-extra.h',
-  'gtkbitmaskprivateimpl.h',
-  'gdkpixbufutilsprivate.h',
  'gtkaccelgroupprivate.h',
  'gtkaccelmapprivate.h',
  'gtkaccessibleattributesetprivate.h',
@ -21,6 +18,7 @@ private_headers = [
  'gtkapplicationprivate.h',
  'gtkatcontextprivate.h',
  'gtkbindingsprivate.h',
+  'gtkbitmaskprivateimpl.h',
  'gtkbitmaskprivate.h',
  'gtkbuilderprivate.h',
  'gtkbuilderscopeprivate.h',
@ -166,6 +164,7 @@ private_headers = [
  'gtknativedialogprivate.h',
  'gtknomediafileprivate.h',
  'gtkpango.h',
+  'gdkpixbufutilsprivate.h',
  'gtkplacessidebarprivate.h',
  'gtkplacesviewprivate.h',
  'gtkplacesviewrowprivate.h',
@ -228,11 +227,14 @@ private_headers = [
  'gtkwin32themeprivate.h',
  'gtkwindowprivate.h',

+  'gtkdbusgenerated.h',
+  'imm-extra.h',
  'text-input-unstable-v3-client-protocol.h',

  'a11y',
  'inspector',
  'roaring',
+  'timsort',
 ]

 images = [
--- a/gdk/gdkdragsurface.c
+++ b/gdk/gdkdragsurface.c
@ -30,6 +30,12 @@
 * during a DND operation.
 */

+/**
+ * GdkDragSurfaceInterface:
+ *
+ * The #GdkDragSurfaceInterface implementation is private to GDK.
+ */
+
 G_DEFINE_INTERFACE (GdkDragSurface, gdk_drag_surface, GDK_TYPE_SURFACE)

 static gboolean
--- a/gdk/x11/gdkkeys-x11.c
+++ b/gdk/x11/gdkkeys-x11.c
@ -1395,7 +1395,7 @@ gdk_x11_keymap_translate_keyboard_state (GdkKeymap       *keymap,
  return tmp_keyval != NoSymbol;
 }

-/**
+/*< private >
 * gdk_x11_keymap_get_group_for_state:
 * @keymap: (type GdkX11Keymap): a #GdkX11Keymap
 * @state: raw state returned from X
@ -1459,7 +1459,7 @@ _gdk_x11_keymap_add_virt_mods (GdkKeymap       *keymap,
    }
 }

-/**
+/*< private >
 * gdk_x11_keymap_key_is_modifier:
 * @keymap: (type GdkX11Keymap): a #GdkX11Keymap
 * @keycode: the hardware keycode from a key event
--- a/gdk/x11/gdkvisual-x11.c
+++ b/gdk/x11/gdkvisual-x11.c
@ -281,7 +281,7 @@ _gdk_x11_screen_init_visuals (GdkX11Screen *x11_screen,
    }
 }

-/**
+/*< private >
 * gdk_x11_screen_lookup_visual:
 * @screen: a #GdkX11Screen.
 * @xvisualid: an X Visual ID.
@ -304,11 +304,11 @@ gdk_x11_screen_lookup_visual (GdkX11Screen *x11_screen,
  return NULL;
 }

-/**
+/*< private >
 * gdk_x11_visual_get_xvisual:
- * @visual: (type GdkX11Visual): a #GdkVisual.
+ * @visual: a #GdkX11Visual.
 *
- * Returns the X visual belonging to a #GdkVisual.
+ * Returns the X visual belonging to a #GdkX11Visual.
 *
 * Returns: (transfer none): an Xlib Visual*.
 **/
--- a/gtk/gtkmodelbutton.c
+++ b/gtk/gtkmodelbutton.c
@ -47,7 +47,7 @@
 #include "gtkshortcut.h"
 #include "gtkaccessibleprivate.h"

-/**
+/*< private >
 * SECTION:gtkmodelbutton
 * @Short_description: A button that uses a GAction as model
 * @Title: GtkModelButton
--- a/gtk/gtktextbuffer.h
+++ b/gtk/gtktextbuffer.h
@ -77,6 +77,10 @@ struct _GtkTextBuffer
 * @begin_user_action: The class handler for the #GtkTextBuffer::begin-user-action signal.
 * @end_user_action: The class handler for the #GtkTextBuffer::end-user-action signal.
 * @paste_done: The class handler for the #GtkTextBuffer::paste-done signal.
+ * @undo: The class handler for the #GtkTextBuffer::undo signal
+ * @redo: The class handler for the #GtkTextBuffer::redo signal
+ *
+ * The class structure for #GtkTextBuffer.
 */
 struct _GtkTextBufferClass
 {
--- a/gtk/gtktreeexpander.c
+++ b/gtk/gtktreeexpander.c
@ -379,7 +379,7 @@ gtk_tree_expander_get_property (GObject    *object,
      break;

    case PROP_ITEM:
-      g_value_set_object (value, gtk_tree_expander_get_item (self));
+      g_value_take_object (value, gtk_tree_expander_get_item (self));
      break;

    case PROP_LIST_ROW:
@ -737,10 +737,13 @@ gtk_tree_expander_set_child (GtkTreeExpander *self,
 *
 * Forwards the item set on the #GtkTreeListRow that @self is managing.
 *
- * This call is essentially equivalent to calling
- * `gtk_tree_list_row_get_item (gtk_tree_expander_get_list_row (@self))`.
+ * This call is essentially equivalent to calling:
 *
- * Returns: (nullable) (transfer none) (type GObject): The item of the row
+ * |[<!-- language="C" -->
+ *   gtk_tree_list_row_get_item (gtk_tree_expander_get_list_row (@self));
+ * ]|
+ *
+ * Returns: (nullable) (transfer full) (type GObject): The item of the row
 **/
 gpointer
 gtk_tree_expander_get_item (GtkTreeExpander *self)