[glib] Documentation fixups

[Matthias Clasen <matthiasc src gnome org>]

commit 807d41b89bcc8d22931dda62b17a6d1a2c8e22ec
Author: Matthias Clasen <mclasen redhat com>
Date:   Sun May 29 00:05:07 2011 -0400

    Documentation fixups

 docs/reference/glib/glib-sections.txt |    7 +++++
 docs/reference/glib/tmpl/macros.sgml  |    3 +-
 glib/gdatetime.c                      |    4 +-
 glib/gkeyfile.c                       |    3 +-
 glib/glist.c                          |    2 +-
 glib/gmarkup.c                        |    4 +-
 glib/gmem.h                           |    2 +-
 glib/gsequence.c                      |   45 +++++++++++++++++---------------
 glib/gslist.c                         |    2 +-
 9 files changed, 41 insertions(+), 31 deletions(-)
---
diff --git a/docs/reference/glib/glib-sections.txt b/docs/reference/glib/glib-sections.txt
index b8dbbb9..8b99515 100644
--- a/docs/reference/glib/glib-sections.txt
+++ b/docs/reference/glib/glib-sections.txt
@@ -337,6 +337,7 @@ G_VA_COPY
 G_STRINGIFY
 G_PASTE
 G_STATIC_ASSERT
+G_STATIC_ASSERT_EXPR
 
 <SUBSECTION>
 G_GNUC_EXTENSION
@@ -564,6 +565,7 @@ G_WIN32_MSG_HANDLE
 g_idle_funcs
 g_timeout_funcs
 g_child_watch_funcs
+GSourcePrivate
 </SECTION>
 
 <SECTION>
@@ -784,6 +786,7 @@ g_atomic_int_exchange_and_add
 
 <SUBSECTION Private>
 G_ATOMIC_OP_MEMORY_BARRIER_NEEDED
+G_ATOMIC_OP_USE_GCC_BUILTINS
 </SECTION>
 
 <SECTION>
@@ -1945,6 +1948,8 @@ g_unix_signal_source_new
 g_unix_signal_add_watch_full
 g_unix_set_fd_nonblocking
 
+<SUBSECTION Private>
+g_unix_error_quark
 </SECTION>
 
 # Data Structures
@@ -2314,6 +2319,8 @@ g_string_down
 g_string_hash
 g_string_equal
 
+<SUBSECTION Private>
+g_string_append_c_inline
 </SECTION>
 
 <SECTION>
diff --git a/docs/reference/glib/tmpl/macros.sgml b/docs/reference/glib/tmpl/macros.sgml
index 7f40eb3..be7fc8a 100644
--- a/docs/reference/glib/tmpl/macros.sgml
+++ b/docs/reference/glib/tmpl/macros.sgml
@@ -208,8 +208,7 @@ Returns the offset, in bytes, of a member of a struct.
 
 <!-- ##### MACRO G_MEM_ALIGN ##### -->
 <para>
-Indicates the number of bytes to which memory will be aligned on the
-current platform.
+
 </para>
 
 
diff --git a/glib/gdatetime.c b/glib/gdatetime.c
index 52a73c7..40ab360 100644
--- a/glib/gdatetime.c
+++ b/glib/gdatetime.c
@@ -1316,8 +1316,8 @@ g_date_time_add_full (GDateTime *datetime,
  * @dt1: first #GDateTime to compare
  * @dt2: second #GDateTime to compare
  *
- * #GCompareFunc-compatible comparison for #GDateTime<!-- -->'s. Both
- * #GDateTime<-- -->'s must be non-%NULL.
+ * #GCompareFunc-compatible comparison for #GDateTimes.
+ * Both #GDateTimes must be non-%NULL.
  *
  * Return value: -1, 0 or 1 if @dt1 is less than, equal to or greater
  *   than @dt2.
diff --git a/glib/gkeyfile.c b/glib/gkeyfile.c
index 3afd781..4039557 100644
--- a/glib/gkeyfile.c
+++ b/glib/gkeyfile.c
@@ -3187,8 +3187,9 @@ g_key_file_has_key (GKeyFile     *key_file,
  * exists. Otherwise, @error is set and %FALSE is returned.
  *
  * Since: 2.30
+ *
  * Rename to: g_key_file_has_key
- **/
+ */
 gboolean
 g_key_file_has_key_full (GKeyFile     *key_file,
 			 const gchar  *group_name,
diff --git a/glib/glist.c b/glib/glist.c
index 7736c93..1e3dd86 100644
--- a/glib/glist.c
+++ b/glib/glist.c
@@ -48,7 +48,7 @@
  * pointers which link to the previous and next elements in the list.
  * Using these pointers it is possible to move through the list in both
  * directions (unlike the <link
- * linkend="glib-Singly-Linked-lists">Singly-Linked Lists</link> which
+ * linkend="glib-Singly-Linked-Lists">Singly-Linked Lists</link> which
  * only allows movement through the list in the forward direction).
  *
  * The data contained in each element can be either integer values, by
diff --git a/glib/gmarkup.c b/glib/gmarkup.c
index cfcde88..2a41005 100644
--- a/glib/gmarkup.c
+++ b/glib/gmarkup.c
@@ -1894,8 +1894,8 @@ g_markup_parse_context_get_position (GMarkupParseContext *context,
  * of g_markup_parse_context_push().
  *
  * Returns: the provided user_data. The returned data belongs to
- *     the markup context and will be freed when g_markup_context_free()
- *     is called.
+ *     the markup context and will be freed when
+ *     g_markup_parse_context_free() is called.
  *
  * Since: 2.18
  */
diff --git a/glib/gmem.h b/glib/gmem.h
index 01d953e..50fccb9 100644
--- a/glib/gmem.h
+++ b/glib/gmem.h
@@ -55,7 +55,7 @@ typedef struct _GMemVTable GMemVTable;
 #if GLIB_SIZEOF_VOID_P > GLIB_SIZEOF_LONG
 /**
  * G_MEM_ALIGN:
- * 
+ *
  * Indicates the number of bytes to which memory will be aligned on the
  * current platform.
  */
diff --git a/glib/gsequence.c b/glib/gsequence.c
index 2654f7b..cc57f58 100644
--- a/glib/gsequence.c
+++ b/glib/gsequence.c
@@ -751,16 +751,17 @@ g_sequence_sort_changed (GSequenceIter    *iter,
  * g_sequence_search:
  * @seq: a #GSequence
  * @data: data for the new item
- * @cmp_func: the #GCompareDataFunc used to compare items in the sequence. It
- *     is called with two items of the @seq and @user_data. It should
- *     return 0 if the items are equal, a negative value if the first
- *     item comes before the second, and a positive value if the second
- *     item comes before the first.
+ * @cmp_func: the function used to compare items in the sequence
  * @cmp_data: user data passed to @cmp_func.
  *
  * Returns an iterator pointing to the position where @data would
  * be inserted according to @cmp_func and @cmp_data.
  *
+ * @cmp_func is called with two items of the @seq and @user_data.
+ * It should return 0 if the items are equal, a negative value if
+ * the first item comes before the second, and a positive value if
+ * the second item comes before the first.
+ *
  * If you are simply searching for an existing element of the sequence,
  * consider using g_sequence_lookup().
  *
@@ -791,21 +792,22 @@ g_sequence_search (GSequence        *seq,
  * g_sequence_lookup:
  * @seq: a #GSequence
  * @data: data to lookup
- * @cmp_func: the #GCompareDataFunc used to compare items in the sequence. It
- *     is called with two items of the @seq and @user_data. It should
- *     return 0 if the items are equal, a negative value if the first
- *     item comes before the second, and a positive value if the second
- *     item comes before the first.
+ * @cmp_func: the function used to compare items in the sequence
  * @cmp_data: user data passed to @cmp_func.
  *
  * Returns an iterator pointing to the position of the first item found
- * equal to @data according to @cmp_func and @cmp_data. If more than one item
- * is equal, it is not guaranteed that it is the first which is returned.
- * In that case, you can use g_sequence_iter_next() and g_sequence_iter_prev()
- * to get others.
+ * equal to @data according to @cmp_func and @cmp_data. If more than one
+ * item is equal, it is not guaranteed that it is the first which is
+ * returned. In that case, you can use g_sequence_iter_next() and
+ * g_sequence_iter_prev() to get others.
  *
- * Return value: an #GSequenceIter pointing to the position of the first item
- * found equal to @data according to @cmp_func and @cmp_data.
+ * @cmp_func is called with two items of the @seq and @user_data.
+ * It should return 0 if the items are equal, a negative value if
+ * the first item comes before the second, and a positive value if
+ * the second item comes before the first.
+ *
+ * Return value: an #GSequenceIter pointing to the position of the
+ *     first item found equal to @data according to @cmp_func and @cmp_data.
  *
  * Since: 2.28
  **/
@@ -830,16 +832,17 @@ g_sequence_lookup (GSequence *seq,
 /**
  * g_sequence_sort_iter:
  * @seq: a #GSequence
- * @cmp_func: the #GSequenceItercompare used to compare iterators in the
- *     sequence. It is called with two iterators pointing into @seq. It should
- *     return 0 if the iterators are equal, a negative value if the first
- *     iterator comes before the second, and a positive value if the second
- *     iterator comes before the first.
+ * @cmp_func: the function used to compare iterators in the sequence
  * @cmp_data: user data passed to @cmp_func
  *
  * Like g_sequence_sort(), but uses a #GSequenceIterCompareFunc instead
  * of a GCompareDataFunc as the compare function
  *
+ * @cmp_func is called with two iterators pointing into @seq. It should
+ * return 0 if the iterators are equal, a negative value if the first
+ * iterator comes before the second, and a positive value if the second
+ * iterator comes before the first.
+ *
  * Since: 2.14
  **/
 void
diff --git a/glib/gslist.c b/glib/gslist.c
index 502591b..1de9c57 100644
--- a/glib/gslist.c
+++ b/glib/gslist.c
@@ -47,7 +47,7 @@
  * pointer which links to the next element in the list. Using this
  * pointer it is possible to move through the list in one direction
  * only (unlike the <link
- * linkend="glib-Doubly-Linked-lists">Doubly-Linked Lists</link> which
+ * linkend="glib-Doubly-Linked-Lists">Doubly-Linked Lists</link> which
  * allow movement in both directions).
  *
  * The data contained in each element can be either integer values, by