String chunks: move docs from tmpl to .c

diff --git a/docs/reference/glib/tmpl/.gitignore b/docs/reference/glib/tmpl/.gitignore
index dcaa602..dce5b29 100644 (file)
--- a/docs/reference/glib/tmpl/.gitignore
+++ b/docs/reference/glib/tmpl/.gitignore
@@ -9,5 +9,6 @@ option.sgml
 random_numbers.sgml
 sequence.sgml
 shell.sgml
+string_chunks.sgml
 threads.sgml
 timers.sgml

diff --git a/docs/reference/glib/tmpl/string_chunks.sgml b/docs/reference/glib/tmpl/string_chunks.sgml
deleted file mode 100644 (file)
index 12b3a53..0000000
--- a/docs/reference/glib/tmpl/string_chunks.sgml
+++ /dev/null
@@ -1,108 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-String Chunks
-
-<!-- ##### SECTION Short_Description ##### -->
-efficient storage of groups of strings
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-String chunks are used to store groups of strings.
-Memory is allocated in blocks, and as strings are added to the #GStringChunk
-they are copied into the next free position in a block. When a block is
-full a new block is allocated.
-</para>
-<para>
-When storing a large number of strings, string chunks are more efficient
-than using g_strdup() since fewer calls to malloc() are needed, and less 
-memory is wasted in memory allocation overheads.
-</para>
-<para>
-By adding strings with g_string_chunk_insert_const() it is also possible
-to remove duplicates.
-</para>
-<para>
-To create a new #GStringChunk use g_string_chunk_new().
-</para>
-<para>
-To add strings to a #GStringChunk use g_string_chunk_insert().
-</para>
-<para>
-To add strings to a #GStringChunk, but without duplicating strings which are
-already in the #GStringChunk, use g_string_chunk_insert_const().
-</para>
-<para>
-To free the entire #GStringChunk use g_string_chunk_free().
-It is not possible to free individual strings.
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### STRUCT GStringChunk ##### -->
-<para>
-An opaque data structure representing String Chunks.
-It should only be accessed by using the following functions.
-</para>
-
-
-<!-- ##### FUNCTION g_string_chunk_new ##### -->
-<para>
-
-</para>
-
-@size: 
-@Returns: 
-
-
-<!-- ##### FUNCTION g_string_chunk_insert ##### -->
-<para>
-
-</para>
-
-@chunk: 
-@string: 
-@Returns: 
-
-
-<!-- ##### FUNCTION g_string_chunk_insert_const ##### -->
-<para>
-
-</para>
-
-@chunk: 
-@string: 
-@Returns: 
-
-
-<!-- ##### FUNCTION g_string_chunk_insert_len ##### -->
-<para>
-
-</para>
-
-@chunk: 
-@string: 
-@len: 
-@Returns: 
-
-
-<!-- ##### FUNCTION g_string_chunk_clear ##### -->
-<para>
-
-</para>
-
-@chunk: 
-
-
-<!-- ##### FUNCTION g_string_chunk_free ##### -->
-<para>
-
-</para>
-
-@chunk: 
-
-

diff --git a/glib/gstring.c b/glib/gstring.c
index dcd9ffb..aaff031 100644 (file)
--- a/glib/gstring.c
+++ b/glib/gstring.c
@@ -44,6 +44,41 @@
 
 #include "galias.h"
 
+/**
+ * SECTION: string_chunks
+ * @title: String Chunks
+ * @short_description: efficient storage of groups of strings
+ *
+ * String chunks are used to store groups of strings. Memory is
+ * allocated in blocks, and as strings are added to the #GStringChunk
+ * they are copied into the next free position in a block. When a block
+ * is full a new block is allocated.
+ *
+ * When storing a large number of strings, string chunks are more
+ * efficient than using g_strdup() since fewer calls to malloc() are
+ * needed, and less memory is wasted in memory allocation overheads.
+ *
+ * By adding strings with g_string_chunk_insert_const() it is also
+ * possible to remove duplicates.
+ *
+ * To create a new #GStringChunk use g_string_chunk_new().
+ *
+ * To add strings to a #GStringChunk use g_string_chunk_insert().
+ *
+ * To add strings to a #GStringChunk, but without duplicating strings
+ * which are already in the #GStringChunk, use
+ * g_string_chunk_insert_const().
+ *
+ * To free the entire #GStringChunk use g_string_chunk_free(). It is
+ * not possible to free individual strings.
+ **/
+
+/**
+ * GStringChunk:
+ *
+ * An opaque data structure representing String Chunks. It should only
+ * be accessed by using the following functions.
+ **/
 struct _GStringChunk
 {
   GHashTable *const_table;