From 9c414d437e930dde107e118c511fbdc7224ff0e4 Mon Sep 17 00:00:00 2001 From: Philip Withnall Date: Wed, 15 Nov 2023 11:38:15 +0000 Subject: [PATCH] docs: Move the gpollableutils SECTION Move it to a separate page. Signed-off-by: Philip Withnall Helps: #3037 --- docs/reference/gio/gio.toml.in | 2 ++ docs/reference/gio/meson.build | 1 + docs/reference/gio/pollable-utils.md | 15 +++++++++++++++ gio/gpollableutils.c | 9 --------- 4 files changed, 18 insertions(+), 9 deletions(-) create mode 100644 docs/reference/gio/pollable-utils.md diff --git a/docs/reference/gio/gio.toml.in b/docs/reference/gio/gio.toml.in index 759c549a1..e4b27d082 100644 --- a/docs/reference/gio/gio.toml.in +++ b/docs/reference/gio/gio.toml.in @@ -46,6 +46,8 @@ content_files = [ "error.md", + "pollable-utils.md", + "dbus-error.md", "dbus-introspection.md", "dbus-name-owning.md", diff --git a/docs/reference/gio/meson.build b/docs/reference/gio/meson.build index 8e973954f..766f39c07 100644 --- a/docs/reference/gio/meson.build +++ b/docs/reference/gio/meson.build @@ -239,6 +239,7 @@ expand_content_files = [ 'migrating-gnome-vfs.md', 'networking.md', 'overview.md', + 'pollable-utils.md', 'tls-overview.md', ] diff --git a/docs/reference/gio/pollable-utils.md b/docs/reference/gio/pollable-utils.md new file mode 100644 index 000000000..c026dd9ab --- /dev/null +++ b/docs/reference/gio/pollable-utils.md @@ -0,0 +1,15 @@ +Title: Pollable Utility Functions +SPDX-License-Identifier: LGPL-2.1-or-later +SPDX-FileCopyrightText: 2012 Dan Winship + +# Pollable Utility Functions + +Utility functions for [iface@Gio.PollableInputStream] and +[iface@Gio.PollableOutputStream] implementations. + + * [func@Gio.pollable_source_new] + * [func@Gio.pollable_source_new_full] + * [func@Gio.pollable_stream_read] + * [func@Gio.pollable_stream_write] + * [func@Gio.pollable_stream_write_all] + diff --git a/gio/gpollableutils.c b/gio/gpollableutils.c index 376a1cf2c..214b4372e 100644 --- a/gio/gpollableutils.c +++ b/gio/gpollableutils.c @@ -26,15 +26,6 @@ #include "gasynchelper.h" #include "glibintl.h" -/** - * SECTION:gpollableutils - * @short_description: Utilities for pollable streams - * @include: gio/gio.h - * - * Utility functions for #GPollableInputStream and - * #GPollableOutputStream implementations. - */ - typedef struct { GSource source;