[gimp] libgimpbase: more API doc fixes



commit d91ff748202b776464588a5f522c00366b42942e
Author: Michael Natterer <mitch gimp org>
Date:   Sun May 31 19:44:39 2015 +0200

    libgimpbase: more API doc fixes

 libgimpbase/gimputils.c      |    2 +-
 libgimpbase/gimpvaluearray.c |    9 +++------
 2 files changed, 4 insertions(+), 7 deletions(-)
---
diff --git a/libgimpbase/gimputils.c b/libgimpbase/gimputils.c
index 129289e..2ce471d 100644
--- a/libgimpbase/gimputils.c
+++ b/libgimpbase/gimputils.c
@@ -335,7 +335,7 @@ gimp_file_has_extension (GFile       *file,
  *
  * Since: GIMP 2.10
  *
- * Return value: %TRUE on success, %FALSE otherwise. On %FASLE, @error
+ * Return value: %TRUE on success, %FALSE otherwise. On %FALSE, @error
  *               is set.
  **/
 gboolean
diff --git a/libgimpbase/gimpvaluearray.c b/libgimpbase/gimpvaluearray.c
index cb39e1f..4597aa3 100644
--- a/libgimpbase/gimpvaluearray.c
+++ b/libgimpbase/gimpvaluearray.c
@@ -34,7 +34,7 @@
  * @short_description: A container structure to maintain an array of
  *     generic values
  * @see_also: #GValue, #GParamSpecValueArray, gimp_param_spec_value_array()
- * @title: Value arrays
+ * @title: GimpValueArray
  *
  * The prime purpose of a #GimpValueArray is for it to be used as an
  * object property that holds an array of values. A #GimpValueArray wraps
@@ -48,8 +48,6 @@
 
 /**
  * GimpValueArray:
- * @n_values: number of values contained in the array
- * @values: array of values
  *
  * A #GimpValueArray contains an array of #GValue elements.
  *
@@ -255,7 +253,7 @@ gimp_value_array_append (GimpValueArray *value_array,
 /**
  * gimp_value_array_insert:
  * @value_array: #GimpValueArray to add an element to
- * @index: insertion position, must be &lt;= value_array-&gt;n_values
+ * @index: insertion position, must be &lt;= gimp_value_array_length()
  * @value: (allow-none): #GValue to copy into #GimpValueArray, or %NULL
  *
  * Insert a copy of @value at specified position into @value_array. If @value
@@ -297,8 +295,7 @@ gimp_value_array_insert (GimpValueArray *value_array,
  * gimp_value_array_remove:
  * @value_array: #GimpValueArray to remove an element from
  * @index: position of value to remove, which must be less than
- *         <code>value_array-><link
- *         linkend="GimpValueArray.n-values">n_values</link></code>
+ *         gimp_value_array_length()
  *
  * Remove the value at position @index from @value_array.
  *


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