From 74735d878fdc630073a1acc9ade2cfb81b67a352 Mon Sep 17 00:00:00 2001 From: Philip Withnall Date: Tue, 14 Nov 2023 13:12:27 +0000 Subject: [PATCH] docs: Move the dbusutils SECTION MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Move it to a separate page as there’s no struct to hang the documentation off. Signed-off-by: Philip Withnall Helps: #3037 --- docs/reference/gio/dbus-utils.md | 28 ++++++++++++++++++++++++++++ docs/reference/gio/gio.toml.in | 1 + docs/reference/gio/meson.build | 1 + gio/gdbusutils.c | 9 --------- 4 files changed, 30 insertions(+), 9 deletions(-) create mode 100644 docs/reference/gio/dbus-utils.md diff --git a/docs/reference/gio/dbus-utils.md b/docs/reference/gio/dbus-utils.md new file mode 100644 index 000000000..70ff84cf5 --- /dev/null +++ b/docs/reference/gio/dbus-utils.md @@ -0,0 +1,28 @@ +Title: D-Bus Utilities +SPDX-License-Identifier: LGPL-2.1-or-later +SPDX-FileCopyrightText: 2010 David Zeuthen + +# D-Bus Utilities + +Various utility routines related to D-Bus. + +GUID support: + * [func@Gio.dbus_is_guid] + * [func@Gio.dbus_generate_guid] + +Name validation: + * [func@Gio.dbus_is_name] + * [func@Gio.dbus_is_unique_name] + * [func@Gio.dbus_is_member_name] + * [func@Gio.dbus_is_interface_name] + * [func@Gio.dbus_is_error_name] + +Conversion between [type@GLib.Variant] and [type@GObject.Value]: + * [func@Gio.dbus_gvariant_to_gvalue] + * [func@Gio.dbus_gvalue_to_gvariant] + +Path escaping: + * [func@Gio.dbus_escape_object_path_bytestring] + * [func@Gio.dbus_escape_object_path] + * [func@Gio.dbus_unescape_object_path] + diff --git a/docs/reference/gio/gio.toml.in b/docs/reference/gio/gio.toml.in index 55c87f75a..7e72fdef9 100644 --- a/docs/reference/gio/gio.toml.in +++ b/docs/reference/gio/gio.toml.in @@ -47,6 +47,7 @@ content_files = [ "dbus-introspection.md", "dbus-name-owning.md", "dbus-name-watching.md", + "dbus-utils.md", "migrating-gdbus.md", "migrating-gconf.md", diff --git a/docs/reference/gio/meson.build b/docs/reference/gio/meson.build index 116b45cec..8f4df9e00 100644 --- a/docs/reference/gio/meson.build +++ b/docs/reference/gio/meson.build @@ -229,6 +229,7 @@ expand_content_files = [ 'dbus-introspection.md', 'dbus-name-owning.md', 'dbus-name-watching.md', + 'dbus-utils.md', 'file-attributes.md', 'migrating-gconf.md', 'migrating-gdbus.md', diff --git a/gio/gdbusutils.c b/gio/gdbusutils.c index 4b4b7e1ef..a76e9ac1a 100644 --- a/gio/gdbusutils.c +++ b/gio/gdbusutils.c @@ -29,15 +29,6 @@ #include "glibintl.h" -/** - * SECTION:gdbusutils - * @title: D-Bus Utilities - * @short_description: Various utilities related to D-Bus - * @include: gio/gio.h - * - * Various utility routines related to D-Bus. - */ - static gboolean is_valid_bus_name_character (gint c, gboolean allow_hyphen)