From caae240bc7d91c6728d17a52fe831519fafa69e4 Mon Sep 17 00:00:00 2001 From: Emmanuele Bassi Date: Wed, 2 Dec 2020 15:10:54 +0000 Subject: [PATCH] docs: Ignore harder First of all, we must list *all* ignored headers. Since we have public headers in the x11 and wayland directories, we must explicitly declare all headers that we consider private under those directories. The "quartz" subdirectory was renamed "macos", with the new macOS backend. The "mir" directory was removed, so there's no need to ignore it. We are also missing a bunch of ignored headers in the top-level gdk directory. Finally, pass the list of ignored files to gtkdoc-mkdb, so we won't get missing declaration warnings. --- docs/reference/gdk/meson.build | 64 ++++++++++++++++++++++++++++------ 1 file changed, 53 insertions(+), 11 deletions(-) diff --git a/docs/reference/gdk/meson.build b/docs/reference/gdk/meson.build index 2037531241..6fe95a5e4a 100644 --- a/docs/reference/gdk/meson.build +++ b/docs/reference/gdk/meson.build @@ -1,16 +1,15 @@ 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', 'gdkdevicepadprivate.h', + 'gdkdeviceprivate.h', 'gdkdevicetoolprivate.h', 'gdkdisplaymanagerprivate.h', 'gdkdisplayprivate.h', @@ -24,12 +23,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', @@ -41,8 +45,43 @@ private_headers = [ 'gdktoplevelsizeprivate.h', 'gdkvulkancontextprivate.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 +95,10 @@ private_headers = [ 'xdg-output-unstable-v1-client-protocol.h', 'xdg-shell-client-protocol.h', 'xdg-shell-unstable-v6-client-protocol.h', - 'win32', - 'quartz', + 'broadway', - 'mir' + 'macos', + 'win32', ] images = [ @@ -123,6 +162,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')),