[gobject-introspection] girepository: Fix documentation comments



commit c72913682407c2564124cce94cb923c4e28b1dfa
Author: Philip Chimento <philip chimento gmail com>
Date:   Sat Jan 29 23:35:52 2022 -0800

    girepository: Fix documentation comments
    
    It was driving me crazy that g_type_info_get_array_length() claimed to
    return an array length.

 girepository/gitypeinfo.c | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
---
diff --git a/girepository/gitypeinfo.c b/girepository/gitypeinfo.c
index e90f9463..4fb7dddd 100644
--- a/girepository/gitypeinfo.c
+++ b/girepository/gitypeinfo.c
@@ -221,8 +221,8 @@ g_type_info_get_interface (GITypeInfo *info)
  * g_type_info_get_array_length:
  * @info: a #GITypeInfo
  *
- * Obtain the array length of the type. The type tag must be a
- * #GI_TYPE_TAG_ARRAY or -1 will returned.
+ * Obtain the position of the argument which gives the array length of the type.
+ * The type tag must be a #GI_TYPE_TAG_ARRAY or -1 will be returned.
  *
  * Returns: the array length, or -1 if the type is not an array
  */
@@ -256,7 +256,7 @@ g_type_info_get_array_length (GITypeInfo *info)
  * @info: a #GITypeInfo
  *
  * Obtain the fixed array size of the type. The type tag must be a
- * #GI_TYPE_TAG_ARRAY or -1 will returned.
+ * #GI_TYPE_TAG_ARRAY or -1 will be returned.
  *
  * Returns: the size or -1 if it's not an array
  */
@@ -290,7 +290,7 @@ g_type_info_get_array_fixed_size (GITypeInfo *info)
  * @info: a #GITypeInfo
  *
  * Obtain if the last element of the array is %NULL. The type tag must be a
- * #GI_TYPE_TAG_ARRAY or %FALSE will returned.
+ * #GI_TYPE_TAG_ARRAY or %FALSE will be returned.
  *
  * Returns: %TRUE if zero terminated
  */


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