From: Matthias Clasen <mclasen@redhat.com>
Date: Sun, 2 Oct 2011 03:27:45 +0000 (-0400)
Subject: Move GString docs inline
X-Git-Tag: 2.31.0~312
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=0e8bcc3ed7121c672af6ce52d8985a4d60f8545b;p=platform%2Fupstream%2Fglib.git

Move GString docs inline
---

diff --git a/docs/reference/glib/tmpl/.gitignore b/docs/reference/glib/tmpl/.gitignore
index 0420458..cc11db4 100644
--- a/docs/reference/glib/tmpl/.gitignore
+++ b/docs/reference/glib/tmpl/.gitignore
@@ -41,6 +41,7 @@ relations.sgml
 sequence.sgml
 shell.sgml
 spawn.sgml
+strings.sgml
 string_chunks.sgml
 string_utils.sgml
 testing.sgml
diff --git a/docs/reference/glib/tmpl/strings.sgml b/docs/reference/glib/tmpl/strings.sgml
deleted file mode 100644
index 3c0b1bc..0000000
--- a/docs/reference/glib/tmpl/strings.sgml
+++ /dev/null
@@ -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: 
-
-
diff --git a/glib/gstring.c b/glib/gstring.c
index 0594a6d..da5b3d6 100644
--- a/glib/gstring.c
+++ b/glib/gstring.c
@@ -391,6 +391,35 @@ g_string_chunk_insert_len (GStringChunk *chunk,
 
 /* 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
 g_string_maybe_expand (GString *string,
                        gsize    len)
diff --git a/glib/gstring.h b/glib/gstring.h
index 9cd64de..68c494f 100644
--- a/glib/gstring.h
+++ b/glib/gstring.h
@@ -40,18 +40,6 @@ G_BEGIN_DECLS
 typedef struct _GString         GString;
 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
 {
   gchar  *str;