luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-09-20 01:06:15 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: Move the GPathBuf SECTION

Browse Source 
Move the contents to the struct docs.

Helps: #3037
This commit is contained in:
Matthias Clasen 2023-09-25 07:56:27 -04:00 committed by Philip Withnall
parent be9a463a10
commit 1dae4fc618
2 changed files with 6 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
glib/gpathbuf.c
View File

@ -15,15 +15,13 @@
#include "gstrfuncs.h" #include "gstrfuncs.h"
/** /**
* SECTION:gpathbuf * GPathBuf:
* @Title: GPathBuf
* @Short_description: A mutable path builder
* *
* `GPathBuf` is a helper type that allows you to easily build paths from * `GPathBuf` is a helper type that allows you to easily build paths from
* individual elements, using the platform specific conventions for path * individual elements, using the platform specific conventions for path
* separators. * separators.
* *
* |[<!-- language="C" --> * ```c
* g_auto (GPathBuf) path; * g_auto (GPathBuf) path;
* *
* g_path_buf_init (&path); * g_path_buf_init (&path);
@ -34,11 +32,11 @@
* *
* g_autofree char *echo = g_path_buf_to_path (&path); * g_autofree char *echo = g_path_buf_to_path (&path);
* g_assert_cmpstr (echo, ==, "/usr/bin/echo"); * g_assert_cmpstr (echo, ==, "/usr/bin/echo");
* ]| * ```
* *
* You can also load a full path and then operate on its components: * You can also load a full path and then operate on its components:
* *
* |[<!-- language="C" --> * ```c
* g_auto (GPathBuf) path; * g_auto (GPathBuf) path;
* *
* g_path_buf_init_from_path (&path, "/usr/bin/echo"); * 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_autofree char *sh = g_path_buf_to_path (&path);
* g_assert_cmpstr (sh, ==, "/usr/bin/sh"); * g_assert_cmpstr (sh, ==, "/usr/bin/sh");
* ]| * ```
* *
* `GPathBuf` is available since GLib 2.76. * Since: 2.76
*/ */
typedef struct { typedef struct {

7
glib/gpathbuf.h
View File

@ -16,13 +16,6 @@ G_BEGIN_DECLS
typedef struct _GPathBuf GPathBuf; 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 struct _GPathBuf
{ {
/*< private >*/ /*< private >*/