[gimp] libgimpbase: document the members of GimpArray, GimpStringArray



commit 9a054fc2483a837d8f78d2d7859ffa797ed8b4a5
Author: Michael Natterer <mitch gimp org>
Date:   Fri Dec 27 19:55:28 2019 +0100

    libgimpbase: document the members of GimpArray, GimpStringArray
    
    and GimpObjectArray.

 libgimpbase/gimpparamspecs.h | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
---
diff --git a/libgimpbase/gimpparamspecs.h b/libgimpbase/gimpparamspecs.h
index 6514e5ab7a..8ed24f93b8 100644
--- a/libgimpbase/gimpparamspecs.h
+++ b/libgimpbase/gimpparamspecs.h
@@ -78,6 +78,12 @@ G_BEGIN_DECLS
  * GIMP_TYPE_ARRAY
  */
 
+/**
+ * GimpArray:
+ * @data:        pointer to the array's data.
+ * @length:      length of @data, in bytes.
+ * @static_data: whether @data points to statically allocated memory.
+ **/
 typedef struct _GimpArray GimpArray;
 
 struct _GimpArray
@@ -306,6 +312,12 @@ void            gimp_value_take_float_array       (GValue        *value,
  * GIMP_TYPE_STRING_ARRAY
  */
 
+/**
+ * GimpStringArray:
+ * @data:        pointer to the array's data.
+ * @length:      length of @data, in number of strings.
+ * @static_data: whether @data points to statically allocated memory.
+ **/
 typedef struct _GimpStringArray GimpStringArray;
 
 struct _GimpStringArray
@@ -411,6 +423,13 @@ void            gimp_value_take_rgb_array       (GValue        *value,
  * GIMP_TYPE_OBJECT_ARRAY
  */
 
+/**
+ * GimpObjectArray:
+ * @object_type: #GType of the contained objects.
+ * @data:        pointer to the array's data.
+ * @length:      length of @data, in number of objects.
+ * @static_data: whether @data points to statically allocated memory.
+ **/
 typedef struct _GimpObjectArray GimpObjectArray;
 
 struct _GimpObjectArray


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