docs: Move the GStrvBuilder SECTION

Move the contents to the struct docs.

Helps: #3037
This commit is contained in:
Matthias Clasen 2023-09-25 07:54:07 -04:00 committed by Philip Withnall
parent c50f94e41e
commit be9a463a10
2 changed files with 4 additions and 15 deletions

View File

@ -27,21 +27,18 @@
#include "gmessages.h" #include "gmessages.h"
/** /**
* SECTION:gstrvbuilder * GStrvBuilder:
* @title: GStrvBuilder
* @short_description: Helper to create NULL-terminated string arrays.
* *
* #GStrvBuilder is a method of easily building dynamically sized * `GStrvBuilder` is a helper object to build a %NULL-terminated string arrays.
* NULL-terminated string arrays.
* *
* The following example shows how to build a two element array: * The following example shows how to build a two element array:
* *
* |[<!-- language="C" --> * ```c
* g_autoptr(GStrvBuilder) builder = g_strv_builder_new (); * g_autoptr(GStrvBuilder) builder = g_strv_builder_new ();
* g_strv_builder_add (builder, "hello"); * g_strv_builder_add (builder, "hello");
* g_strv_builder_add (builder, "world"); * g_strv_builder_add (builder, "world");
* g_auto(GStrv) array = g_strv_builder_end (builder); * g_auto(GStrv) array = g_strv_builder_end (builder);
* ]| * ```
* *
* Since: 2.68 * Since: 2.68
*/ */

View File

@ -30,14 +30,6 @@
G_BEGIN_DECLS G_BEGIN_DECLS
/**
* GStrvBuilder:
*
* A helper object to build a %NULL-terminated string array
* by appending. See g_strv_builder_new().
*
* Since: 2.68
*/
typedef struct _GStrvBuilder GStrvBuilder; typedef struct _GStrvBuilder GStrvBuilder;
GLIB_AVAILABLE_IN_2_68 GLIB_AVAILABLE_IN_2_68