luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-04-14 11:38:05 +02:00
Code Issues Packages Projects Releases Wiki Activity

Move GString docs inline

Browse Source
This commit is contained in:
Matthias Clasen 2011-10-01 23:27:45 -04:00
parent 459b14d89a
commit 0e8bcc3ed7
4 changed files with 30 additions and 381 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/reference/glib/tmpl/.gitignore vendored
View File

@ -41,6 +41,7 @@ relations.sgml
sequence.sgml sequence.sgml
shell.sgml shell.sgml
spawn.sgml spawn.sgml
strings.sgml
string_chunks.sgml string_chunks.sgml
string_utils.sgml string_utils.sgml
testing.sgml testing.sgml

369
docs/reference/glib/tmpl/strings.sgml
View File

@ -1,369 +0,0 @@
<!-- ##### SECTION Title ##### -->
Strings
<!-- ##### SECTION Short_Description ##### -->
text buffers which grow automatically as text is added
<!-- ##### SECTION Long_Description ##### -->
<para>
A #GString is an object that handles the memory management of a C string
for you. You can think of it as similar to a Java StringBuffer.
In addition to the string itself, GString stores the length of the string,
so can be used for binary data with embedded nul bytes. To access the C
string managed by the GString @string, simply use @string->str.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### STRUCT GString ##### -->
<para>
The #GString struct contains the public fields of a #GString.
</para>
@str: points to the character data. It may move as text is added.
The <structfield>str</structfield> field is nul-terminated and so
can be used as an ordinary C string.
@len: contains the length of the string, not including the
terminating nul byte.
@allocated_len: the number of bytes that can be stored in the
string before it needs to be reallocated. May be larger than @len.
<!-- ##### FUNCTION g_string_new ##### -->
<para>
</para>
@init:
@Returns:
<!-- ##### FUNCTION g_string_new_len ##### -->
<para>
</para>
@init:
@len:
@Returns:
<!-- ##### FUNCTION g_string_sized_new ##### -->
<para>
</para>
@dfl_size:
@Returns:
<!-- ##### FUNCTION g_string_assign ##### -->
<para>
</para>
@string:
@rval:
@Returns:
<!-- ##### MACRO g_string_sprintf ##### -->
<para>
</para>
<!-- ##### MACRO g_string_sprintfa ##### -->
<para>
</para>
<!-- ##### FUNCTION g_string_vprintf ##### -->
<para>
</para>
@string:
@format:
@args:
<!-- ##### FUNCTION g_string_append_vprintf ##### -->
<para>
</para>
@string:
@format:
@args:
<!-- ##### FUNCTION g_string_printf ##### -->
<para>
</para>
@string:
@format:
@Varargs:
<!-- ##### FUNCTION g_string_append_printf ##### -->
<para>
</para>
@string:
@format:
@Varargs:
<!-- ##### FUNCTION g_string_append ##### -->
<para>
</para>
@string:
@val:
@Returns:
<!-- ##### FUNCTION g_string_append_c ##### -->
<para>
</para>
@string:
@c:
@Returns:
<!-- ##### FUNCTION g_string_append_unichar ##### -->
<para>
</para>
@string:
@wc:
@Returns:
<!-- ##### FUNCTION g_string_append_len ##### -->
<para>
</para>
@string:
@val:
@len:
@Returns:
<!-- ##### FUNCTION g_string_append_uri_escaped ##### -->
<para>
</para>
@string:
@unescaped:
@reserved_chars_allowed:
@allow_utf8:
@Returns:
<!-- ##### FUNCTION g_string_prepend ##### -->
<para>
</para>
@string:
@val:
@Returns:
<!-- ##### FUNCTION g_string_prepend_c ##### -->
<para>
</para>
@string:
@c:
@Returns:
<!-- ##### FUNCTION g_string_prepend_unichar ##### -->
<para>
</para>
@string:
@wc:
@Returns:
<!-- ##### FUNCTION g_string_prepend_len ##### -->
<para>
</para>
@string:
@val:
@len:
@Returns:
<!-- ##### FUNCTION g_string_insert ##### -->
<para>
</para>
@string:
@pos:
@val:
@Returns:
<!-- ##### FUNCTION g_string_insert_c ##### -->
<para>
</para>
@string:
@pos:
@c:
@Returns:
<!-- ##### FUNCTION g_string_insert_unichar ##### -->
<para>
</para>
@string:
@pos:
@wc:
@Returns:
<!-- ##### FUNCTION g_string_insert_len ##### -->
<para>
</para>
@string:
@pos:
@val:
@len:
@Returns:
<!-- ##### FUNCTION g_string_overwrite ##### -->
<para>
</para>
@string:
@pos:
@val:
@Returns:
<!-- ##### FUNCTION g_string_overwrite_len ##### -->
<para>
</para>
@string:
@pos:
@val:
@len:
@Returns:
<!-- ##### FUNCTION g_string_erase ##### -->
<para>
</para>
@string:
@pos:
@len:
@Returns:
<!-- ##### FUNCTION g_string_truncate ##### -->
<para>
</para>
@string:
@len:
@Returns:
<!-- ##### FUNCTION g_string_set_size ##### -->
<para>
</para>
@string:
@len:
@Returns:
<!-- ##### FUNCTION g_string_free ##### -->
<para>
</para>
@string:
@free_segment:
@Returns:
<!-- ##### FUNCTION g_string_up ##### -->
<para>
</para>
@string:
@Returns:
<!-- ##### FUNCTION g_string_down ##### -->
<para>
</para>
@string:
@Returns:
<!-- ##### FUNCTION g_string_hash ##### -->
<para>
</para>
@str:
@Returns:
<!-- ##### FUNCTION g_string_equal ##### -->
<para>
</para>
@v:
@v2:
@Returns:

29
glib/gstring.c
View File

@ -391,6 +391,35 @@ g_string_chunk_insert_len (GStringChunk *chunk,
/* Strings. /* Strings.
*/ */
/**
* SECTION:strings
* @title: Strings
* @short_description: text buffers which grow automatically
* as text is added
*
* A #GString is an object that handles the memory management
* of a C string for you. You can think of it as similar to a
* Java StringBuffer. In addition to the string itself, GString
* stores the length of the string, so can be used for binary
* data with embedded nul bytes. To access the C string managed
* by the GString @string, simply use @string->str.
*/
/**
* GString:
* @str: points to the character data. It may move as text is added.
* The @str field is null-terminated and so
* can be used as an ordinary C string.
* @len: contains the length of the string, not including the
* terminating nul byte.
* @allocated_len: the number of bytes that can be stored in the
* string before it needs to be reallocated. May be larger than @len.
*
* The GString struct contains the public fields of a GString.
*/
static void static void
g_string_maybe_expand (GString *string, g_string_maybe_expand (GString *string,
gsize len) gsize len)

12
glib/gstring.h
View File

@ -40,18 +40,6 @@ G_BEGIN_DECLS
typedef struct _GString GString; typedef struct _GString GString;
typedef struct _GStringChunk GStringChunk; typedef struct _GStringChunk GStringChunk;
/**
* GString:
* @str: points to the character data. It may move as text is added.
* The @str field is null-terminated and so
* can be used as an ordinary C string.
* @len: contains the length of the string, not including the
* terminating nul byte.
* @allocated_len: the number of bytes that can be stored in the
* string before it needs to be reallocated. May be larger than @len.
*
* The #GString struct contains the public fields of a #GString.
*/
struct _GString struct _GString
{ {
gchar *str; gchar *str;