From 1dae4fc618d351d604ba5e00ab497a03797d55b7 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Mon, 25 Sep 2023 07:56:27 -0400 Subject: [PATCH] docs: Move the GPathBuf SECTION Move the contents to the struct docs. Helps: #3037 --- glib/gpathbuf.c | 14 ++++++-------- glib/gpathbuf.h | 7 ------- 2 files changed, 6 insertions(+), 15 deletions(-) diff --git a/glib/gpathbuf.c b/glib/gpathbuf.c index c7cf04849..e51f3f1bd 100644 --- a/glib/gpathbuf.c +++ b/glib/gpathbuf.c @@ -15,15 +15,13 @@ #include "gstrfuncs.h" /** - * SECTION:gpathbuf - * @Title: GPathBuf - * @Short_description: A mutable path builder + * GPathBuf: * * `GPathBuf` is a helper type that allows you to easily build paths from * individual elements, using the platform specific conventions for path * separators. * - * |[ + * ```c * g_auto (GPathBuf) path; * * g_path_buf_init (&path); @@ -34,11 +32,11 @@ * * g_autofree char *echo = g_path_buf_to_path (&path); * g_assert_cmpstr (echo, ==, "/usr/bin/echo"); - * ]| + * ``` * * You can also load a full path and then operate on its components: * - * |[ + * ```c * g_auto (GPathBuf) path; * * g_path_buf_init_from_path (&path, "/usr/bin/echo"); @@ -48,9 +46,9 @@ * * g_autofree char *sh = g_path_buf_to_path (&path); * g_assert_cmpstr (sh, ==, "/usr/bin/sh"); - * ]| + * ``` * - * `GPathBuf` is available since GLib 2.76. + * Since: 2.76 */ typedef struct { diff --git a/glib/gpathbuf.h b/glib/gpathbuf.h index b42341998..1ea01f035 100644 --- a/glib/gpathbuf.h +++ b/glib/gpathbuf.h @@ -16,13 +16,6 @@ G_BEGIN_DECLS typedef struct _GPathBuf GPathBuf; -/** - * GPathBuf: (copy-func g_path_buf_copy) (free-func g_path_buf_free) - * - * A mutable path builder. - * - * Since: 2.76 - */ struct _GPathBuf { /*< private >*/