[glib/glib-2-28] g_value_array_remove(): clarify docstring formatting



commit 6e6b2db6130a280e2841765d3016c85e88f62cec
Author: Will Thompson <will thompson collabora co uk>
Date:   Thu Mar 3 14:51:41 2011 +0000

    g_value_array_remove(): clarify docstring formatting

 gobject/gvaluearray.c |    4 +++-
 1 files changed, 3 insertions(+), 1 deletions(-)
---
diff --git a/gobject/gvaluearray.c b/gobject/gvaluearray.c
index e2a752e..2f1028a 100644
--- a/gobject/gvaluearray.c
+++ b/gobject/gvaluearray.c
@@ -261,7 +261,9 @@ g_value_array_insert (GValueArray  *value_array,
 /**
  * g_value_array_remove:
  * @value_array: #GValueArray to remove an element from
- * @index_: position of value to remove, must be &lt; value_array->n_values
+ * @index_: position of value to remove, which must be less than
+ *          <code>value_array-><link
+ *          linkend="GValueArray.n-values">n_values</link></code>
  *
  * Remove the value at position @index_ from @value_array.
  *



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]