[aravis] Name nitpicking and doc warning fixes.



commit ec71740b2e6e6307fff3c1a79a4fc31176c4f407
Author: Emmanuel Pacaud <emmanuel gnome org>
Date:   Mon Jul 9 10:54:04 2012 +0200

    Name nitpicking and doc warning fixes.

 docs/reference/aravis/aravis-sections.txt |    8 +++++++-
 src/arvcamera.c                           |    8 ++++----
 src/arvdevice.c                           |   15 +++++++++++++--
 src/arvdevice.h                           |    4 ++--
 4 files changed, 26 insertions(+), 9 deletions(-)
---
diff --git a/docs/reference/aravis/aravis-sections.txt b/docs/reference/aravis/aravis-sections.txt
index fc23f58..caeeb3b 100644
--- a/docs/reference/aravis/aravis-sections.txt
+++ b/docs/reference/aravis/aravis-sections.txt
@@ -21,7 +21,10 @@ arv_camera_get_binning
 arv_camera_set_pixel_format
 arv_camera_get_pixel_format
 arv_camera_get_pixel_format_as_string
+arv_camera_set_pixel_format_from_string
 arv_camera_get_available_pixel_formats
+arv_camera_get_available_pixel_formats_as_display_names
+arv_camera_get_available_pixel_formats_as_strings
 arv_camera_start_acquisition
 arv_camera_stop_acquisition
 arv_camera_set_acquisition_mode
@@ -234,7 +237,8 @@ arv_device_get_integer_feature_bounds
 arv_device_set_float_feature_value
 arv_device_get_float_feature_value
 arv_device_get_float_feature_bounds
-arv_device_get_enumeration_feature_available_values
+arv_device_get_available_enumeration_feature_values
+arv_device_get_available_enumeration_feature_values_as_strings
 <SUBSECTION Standard>
 ARV_DEVICE
 ARV_IS_DEVICE
@@ -386,6 +390,7 @@ arv_gc_feature_node_get_value_type
 arv_gc_feature_node_get_value_as_string
 arv_gc_feature_node_set_value_from_string
 arv_gc_feature_node_get_name
+arv_gc_feature_node_get_display_name
 arv_gc_feature_node_get_tooltip
 arv_gc_feature_node_get_description
 arv_gc_feature_node_is_available
@@ -464,6 +469,7 @@ arv_gc_enumeration_get_int_value
 arv_gc_enumeration_set_int_value
 arv_gc_enumeration_get_entries
 arv_gc_enumeration_get_available_int_values
+arv_gc_enumeration_get_available_string_values
 <SUBSECTION Standard>
 ARV_GC_ENUMERATION
 ARV_IS_GC_ENUMERATION
diff --git a/src/arvcamera.c b/src/arvcamera.c
index 88b4260..d6f6e86 100644
--- a/src/arvcamera.c
+++ b/src/arvcamera.c
@@ -380,7 +380,7 @@ arv_camera_get_pixel_format_as_string (ArvCamera *camera)
  *
  * Retrieves the list of all available pixel formats.
  *
- * Returns: (array length=n_pixel_formats) (transfer full): a newly allocated array of #ArvPixelFormat
+ * Returns: (array length=n_pixel_formats) (transfer container): a newly allocated array of #ArvPixelFormat
  */
 
 gint64 *
@@ -388,7 +388,7 @@ arv_camera_get_available_pixel_formats (ArvCamera *camera, guint *n_pixel_format
 {
 	g_return_val_if_fail (ARV_IS_CAMERA (camera), NULL);
 
-	return arv_device_get_enumeration_feature_available_values (camera->priv->device, "PixelFormat", n_pixel_formats);
+	return arv_device_get_available_enumeration_feature_values (camera->priv->device, "PixelFormat", n_pixel_formats);
 }
 
 /**
@@ -398,7 +398,7 @@ arv_camera_get_available_pixel_formats (ArvCamera *camera, guint *n_pixel_format
  *
  * Retrieves the list of all available pixel formats as strings.
  *
- * Returns: (array length=n_pixel_formats) (transfer full): a newly allocated array of strings.
+ * Returns: (array length=n_pixel_formats) (transfer container): a newly allocated array of strings.
  */
 
 const char **
@@ -406,7 +406,7 @@ arv_camera_get_available_pixel_formats_as_strings (ArvCamera *camera, guint *n_p
 {
 	g_return_val_if_fail (ARV_IS_CAMERA (camera), NULL);
 
-	return arv_device_get_enumeration_feature_available_strings (camera->priv->device, "PixelFormat", n_pixel_formats);
+	return arv_device_get_available_enumeration_feature_values_as_strings (camera->priv->device, "PixelFormat", n_pixel_formats);
 }
 
 /**
diff --git a/src/arvdevice.c b/src/arvdevice.c
index eda5064..a7767b5 100644
--- a/src/arvdevice.c
+++ b/src/arvdevice.c
@@ -458,7 +458,7 @@ arv_device_get_float_feature_bounds (ArvDevice *device, const char *feature, dou
 }
 
 gint64 *
-arv_device_get_enumeration_feature_available_values (ArvDevice *device, const char *feature, guint *n_values)
+arv_device_get_available_enumeration_feature_values (ArvDevice *device, const char *feature, guint *n_values)
 {
 	ArvGcNode *node;
 	GError *error = NULL;
@@ -487,8 +487,19 @@ arv_device_get_enumeration_feature_available_values (ArvDevice *device, const ch
 	return values;
 }
 
+/**
+ * arv_device_get_available_enumeration_feature_values_as_strings:
+ * @device: an #ArvDevice
+ * @feature: feature name
+ * @n_values: placeholder for the number of returned values
+ *
+ * Get all the available values of @feature, as strings.
+ *
+ * Returns: (array length=n_values) (transfer container): a newly created array of const strings, which must freed after use using g_free.
+ */
+
 const char **
-arv_device_get_enumeration_feature_available_strings (ArvDevice *device, const char *feature, guint *n_values)
+arv_device_get_available_enumeration_feature_values_as_strings (ArvDevice *device, const char *feature, guint *n_values)
 {
 	ArvGcNode *node;
 	GError *error = NULL;
diff --git a/src/arvdevice.h b/src/arvdevice.h
index db7c402..b7673c1 100644
--- a/src/arvdevice.h
+++ b/src/arvdevice.h
@@ -113,8 +113,8 @@ double		arv_device_get_float_feature_value	(ArvDevice *device, const char *featu
 void 		arv_device_get_float_feature_bounds 	(ArvDevice *device, const char *feature,
 							 double *min, double *max);
 
-gint64 *	arv_device_get_enumeration_feature_available_values	(ArvDevice *device, const char *feature, guint *n_values);
-const char **	arv_device_get_enumeration_feature_available_strings	(ArvDevice *device, const char *feature, guint *n_values);
+gint64 *	arv_device_get_available_enumeration_feature_values		(ArvDevice *device, const char *feature, guint *n_values);
+const char **	arv_device_get_available_enumeration_feature_values_as_strings	(ArvDevice *device, const char *feature, guint *n_values);
 
 ArvDeviceStatus arv_device_get_status			(ArvDevice *device);
 



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