[aravis] gc_enumeration: add code annotation.



commit a62a6030ee3de5484fbc09e6d6aaf4f346baa3e0
Author: Emmanuel Pacaud <emmanuel gnome org>
Date:   Mon Jul 9 10:52:39 2012 +0200

    gc_enumeration: add code annotation.
    
    One day I will add all the missing doc. It's just not today.

 src/arvgcenumeration.c |   11 +++++++++++
 1 files changed, 11 insertions(+), 0 deletions(-)
---
diff --git a/src/arvgcenumeration.c b/src/arvgcenumeration.c
index 0ea0a2f..4107135 100644
--- a/src/arvgcenumeration.c
+++ b/src/arvgcenumeration.c
@@ -286,6 +286,17 @@ arv_gc_enumeration_get_available_int_values (ArvGcEnumeration *enumeration, guin
 	return values;
 }
 
+/**
+ * arv_gc_enumeration_get_available_string_values:
+ * @enumeration: an #ArvGcEnumeration
+ * @n_values: (out): placeholder for the number of values
+ * @error: placeholder for error, may be NULL
+ *
+ * Create an array of all available values of @enumeration, as strings.
+ *
+ * Returns: (array length=n_values) (transfer container): an newly created array of const strings, which must freed after use using g_free.
+ */
+
 const char **
 arv_gc_enumeration_get_available_string_values (ArvGcEnumeration *enumeration, guint *n_values, GError **error)
 {



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