From dba5d498edab36d50e3dd8286fff478a0699aaa7 Mon Sep 17 00:00:00 2001 From: Simon McVittie <smcv@collabora.com> Date: Tue, 29 Sep 2020 18:26:56 +0100 Subject: [PATCH] Fix various gtk-doc warnings Signed-off-by: Simon McVittie <smcv@collabora.com> --- docs/reference/steam-runtime-tools.xml | 4 ++++ steam-runtime-tools/glib-backports.c | 8 ++++---- steam-runtime-tools/graphics.h | 1 + steam-runtime-tools/library.h | 2 ++ steam-runtime-tools/resolve-in-sysroot-internal.h | 1 + steam-runtime-tools/system-info.c | 4 +++- steam-runtime-tools/system-info.h | 2 +- 7 files changed, 16 insertions(+), 6 deletions(-) diff --git a/docs/reference/steam-runtime-tools.xml b/docs/reference/steam-runtime-tools.xml index c9038ed68..edf6993c7 100644 --- a/docs/reference/steam-runtime-tools.xml +++ b/docs/reference/steam-runtime-tools.xml @@ -19,7 +19,11 @@ <chapter id="ch-specific"> <title>Specific system information</title> <xi:include href="xml/architecture.xml"/> + <xi:include href="xml/cpu-feature.xml"/> + <xi:include href="xml/desktop-entry.xml"/> + <xi:include href="xml/graphics.xml"/> <xi:include href="xml/library.xml"/> + <xi:include href="xml/locale.xml"/> <xi:include href="xml/runtime.xml"/> <xi:include href="xml/steam.xml"/> </chapter> diff --git a/steam-runtime-tools/glib-backports.c b/steam-runtime-tools/glib-backports.c index f6c9ab294..2d637a3e6 100644 --- a/steam-runtime-tools/glib-backports.c +++ b/steam-runtime-tools/glib-backports.c @@ -38,7 +38,7 @@ G_DEFINE_QUARK (g-spawn-exit-error-quark, my_g_spawn_exit_error) #endif #if !GLIB_CHECK_VERSION (2, 36, 0) -/** +/* * g_close: * @fd: A file descriptor * @error: a #GError @@ -86,7 +86,7 @@ my_g_close (gint fd, #endif #if !GLIB_CHECK_VERSION (2, 34, 0) -/** +/* * g_spawn_check_exit_status: * @exit_status: An exit code as returned from g_spawn_sync() * @error: a #GError @@ -208,7 +208,7 @@ my_g_ptr_array_insert (GPtrArray *arr, #endif #if !GLIB_CHECK_VERSION (2, 36, 0) -/** +/* * g_dbus_address_escape_value: * @string: an unescaped string to be included in a D-Bus address * as the value in a key-value pair @@ -352,7 +352,7 @@ my_g_unix_fd_add_full (int priority, #endif #if !GLIB_CHECK_VERSION(2, 58, 0) -/** +/* * g_canonicalize_filename: * @filename: (type filename): the name of the file * @relative_to: (type filename) (nullable): the relative directory, or %NULL diff --git a/steam-runtime-tools/graphics.h b/steam-runtime-tools/graphics.h index 1d4b7590e..275161560 100644 --- a/steam-runtime-tools/graphics.h +++ b/steam-runtime-tools/graphics.h @@ -117,6 +117,7 @@ typedef enum * @SRT_RENDERING_INTERFACE_GLESV2: GLESv2 rendering interfaces * @SRT_RENDERING_INTERFACE_VULKAN: Vulkan rendering interface * @SRT_RENDERING_INTERFACE_VDPAU: VDPAU rendering interface + * @SRT_RENDERING_INTERFACE_VAAPI: VA-API rendering interface */ typedef enum { diff --git a/steam-runtime-tools/library.h b/steam-runtime-tools/library.h index 88b0d4a0e..a76aee203 100644 --- a/steam-runtime-tools/library.h +++ b/steam-runtime-tools/library.h @@ -99,7 +99,9 @@ _SRT_PUBLIC const char *srt_library_get_requested_name (SrtLibrary *self); _SRT_PUBLIC const char *srt_library_get_absolute_path (SrtLibrary *self); +#ifndef __GTK_DOC_IGNORE__ _SRT_PUBLIC G_DEPRECATED_FOR(srt_library_get_requested_name) +#endif const char *srt_library_get_soname (SrtLibrary *self); _SRT_PUBLIC const char *srt_library_get_messages (SrtLibrary *self); diff --git a/steam-runtime-tools/resolve-in-sysroot-internal.h b/steam-runtime-tools/resolve-in-sysroot-internal.h index 7d47024e7..67f8b49ad 100644 --- a/steam-runtime-tools/resolve-in-sysroot-internal.h +++ b/steam-runtime-tools/resolve-in-sysroot-internal.h @@ -1,3 +1,4 @@ +/*<private_header>*/ /* * Copyright © 2020 Collabora Ltd. * diff --git a/steam-runtime-tools/system-info.c b/steam-runtime-tools/system-info.c index 770c701d0..e8b7cff73 100644 --- a/steam-runtime-tools/system-info.c +++ b/steam-runtime-tools/system-info.c @@ -558,6 +558,7 @@ static gchar ** _srt_system_info_get_pinned_libs_from_report (JsonObject *json_o /** * srt_system_info_new_from_json: * @path: (not nullable) (type filename): Path to a JSON report + * @error: Used to raise an error on failure * * Return a new #SrtSystemInfo with the info parsed from an existing JSON * report. @@ -1777,7 +1778,7 @@ srt_system_info_check_graphics (SrtSystemInfo *self, * Check whether various combinations of rendering interface and windowing * system are available. The specific combinations of rendering interface and * windowing system that are returned are not guaranteed, but will include at - * least %SRT_RENDERER_GL on %SRT_WINDOW_SYSTEM_GLX. Additional combinations + * least %SRT_RENDERING_INTERFACE_GL on %SRT_WINDOW_SYSTEM_GLX. Additional combinations * will be added in future versions of this library. * * Returns: (transfer full) (type SrtGraphics): A list of #SrtGraphics objects @@ -3358,6 +3359,7 @@ srt_system_info_get_container_type (SrtSystemInfo *self) /** * srt_system_info_dup_container_host_directory: + * @self: The #SrtSystemInfo object * * If the program appears to be running in a container, return the * directory where host files can be found. For example, if this function diff --git a/steam-runtime-tools/system-info.h b/steam-runtime-tools/system-info.h index 1e73cdbd0..d74395491 100644 --- a/steam-runtime-tools/system-info.h +++ b/steam-runtime-tools/system-info.h @@ -130,7 +130,7 @@ SrtLibraryIssues srt_system_info_check_libraries (SrtSystemInfo *self, _SRT_PUBLIC SrtLibraryIssues srt_system_info_check_library (SrtSystemInfo *self, const gchar *multiarch_tuple, - const gchar *soname, + const gchar *requested_name, SrtLibrary **more_details_out); _SRT_PUBLIC -- GitLab