[aravis] introspection: more annotations. Fix comment syntax.

[Emmanuel Pacaud <emmanuel src gnome org>]

commit 777891240dc8eb4563b8181784b112542e24a0cf
Author: Emmanuel Pacaud <emmanuel gnome org>
Date:   Fri May 21 11:26:06 2010 +0200

    introspection: more annotations. Fix comment syntax.

 src/arvcamera.c    |  249 ++++++++++++++++++++++++++--------------------------
 src/arvdevice.c    |    9 ++
 src/arvevaluator.c |    9 ++
 src/arvgc.c        |   19 ++++
 4 files changed, 162 insertions(+), 124 deletions(-)
---
diff --git a/src/arvcamera.c b/src/arvcamera.c
index b15c5b8..0d79d20 100644
--- a/src/arvcamera.c
+++ b/src/arvcamera.c
@@ -51,9 +51,10 @@ arv_camera_create_stream (ArvCamera *camera, ArvStreamCallback callback, void *u
 /* Device control */
 
 /**
-   arv_camera_get_vendor_name:
-
-   Returns: A string with the camera vendor name.
+ * arv_camera_get_vendor_name:
+ *
+ * @camera: a #ArvCamera object
+ * Return value: the camera vendor name.
  */
 
 const char *
@@ -65,9 +66,10 @@ arv_camera_get_vendor_name (ArvCamera *camera)
 }
 
 /**
-   arv_camera_get_model_name:
-
-   Returns: A string with the camera model name.
+ * arv_camera_get_model_name:
+ *
+ * @camera: a #ArvCamera object
+ * Return value: the camera model name.
  */
 
 const char *
@@ -79,9 +81,10 @@ arv_camera_get_model_name (ArvCamera *camera)
 }
 
 /**
-   arv_camera_get_device_id:
-
-   Returns: A string with the device ID.
+ * arv_camera_get_device_id:
+ *
+ * @camera: a #ArvCamera object
+ * Return value: the camera device ID.
  */
 
 const char *
@@ -95,10 +98,11 @@ arv_camera_get_device_id (ArvCamera *camera)
 /* Image format control */
 
 /**
-   arv_camera_get_sensor_size:
-
-   @width: a placeholder for the camera sensor width
-   @height: a placeholder for the camera sensor height
+ * arv_camera_get_sensor_size:
+ *
+ * @camera: a #ArvCamera object
+ * @width: camera sensor width placeholder
+ * @height: camera sensor height placeholder
  */
 
 void
@@ -113,15 +117,15 @@ arv_camera_get_sensor_size (ArvCamera *camera, gint *width, gint *height)
 }
 
 /**
-   arv_camera_set_region:
-
-   @camera: a camera object
-   @x: x offset
-   @y: y_offset
-   @width: region width
-   @height: region height
-
-   Defines the region of interest which will be transmitted in the video stream.
+ * arv_camera_set_region:
+ *
+ * @camera: a #ArvCamera object
+ * @x: x offset
+ * @y: y_offset
+ * @width: region width
+ * @height: region height
+ *
+ * Defines the region of interest which will be transmitted in the video stream.
  */
 
 void
@@ -140,15 +144,15 @@ arv_camera_set_region (ArvCamera *camera, int x, int y, int width, int height)
 }
 
 /**
-   arv_camera_get_region:
-
-   @camera: a camera object
-   @x: placeholder for the x offset
-   @y: placeholder for the y_offset
-   @width: placeholder for the region width
-   @height: placeholder for the region height
-
-   Retrieves the current region of interest.
+ * arv_camera_get_region:
+ *
+ * @camera: a #ArvCamera object
+ * @x: x offset placeholder
+ * @y: y_offset placeholder
+ * @width: region width placeholder
+ * @height: region height placeholder
+ *
+ * Retrieves the current region of interest.
  */
 
 void
@@ -167,13 +171,13 @@ arv_camera_get_region (ArvCamera *camera, gint *x, gint *y, gint *width, gint *h
 }
 
 /**
-   arv_camera_set_binning:
-
-   @camera: a camera object
-   @dx: horizontal binning
-   @dy: vertical binning
-
-   Defines the binning in both directions. Not all cameras support this feature.
+ * arv_camera_set_binning:
+ *
+ * @camera: a #ArvCamera object
+ * @dx: horizontal binning
+ * @dy: vertical binning
+ *
+ * Defines the binning in both directions. Not all cameras support this feature.
  */
 
 void
@@ -188,13 +192,13 @@ arv_camera_set_binning (ArvCamera *camera, gint dx, gint dy)
 }
 
 /**
-   arv_camera_get_binning:
-
-   @camera: a camera object
-   @dx: horizontal binning placeholder
-   @dy: vertical binning placeholder
-
-   Retrieves the binning in both directions.
+ * arv_camera_get_binning:
+ * 
+ * @camera: a #ArvCamera object
+ * @dx: horizontal binning placeholder
+ * @dy: vertical binning placeholder
+ *
+ * Retrieves the binning in both directions.
  */
 
 void
@@ -209,12 +213,12 @@ arv_camera_get_binning (ArvCamera *camera, gint *dx, gint *dy)
 }
 
 /**
-   arv_camera_set_pixel_format:
-
-   @camera: a camera object
-   @format: pixel format
-
-   Defines the pixel format.
+ * arv_camera_set_pixel_format:
+ *
+ * @camera: a #ArvCamera object
+ * @format: pixel format
+ *
+ * Defines the pixel format.
  */
 
 void
@@ -226,12 +230,12 @@ arv_camera_set_pixel_format (ArvCamera *camera, ArvPixelFormat format)
 }
 
 /**
-   arv_camera_get_pixel_format:
-
-   @camera: a camera object
-   @format: pixel format placeholder
-
-   Retrieves the pixel format.
+ * arv_camera_get_pixel_format:
+ *
+ * @camera: a #ArvCamera object
+ * @format: pixel format placeholder
+ *
+ * Retrieves the pixel format.
  */
 
 ArvPixelFormat
@@ -245,11 +249,11 @@ arv_camera_get_pixel_format (ArvCamera *camera)
 /* Acquisition control */
 
 /**
-   arv_camera_start_acquisition:
-
-   @camera: a camera object
-
-   Starts the video stream acquisition.
+ * arv_camera_start_acquisition:
+ *
+ * @camera: a #ArvCamera object
+ *
+ * Starts the video stream acquisition.
  */
 
 void
@@ -261,11 +265,11 @@ arv_camera_start_acquisition (ArvCamera *camera)
 }
 
 /**
-   arv_camera_stop_acquisition:
-
-   @camera: a camera object
-
-   Stops the video stream acquisition.
+ * arv_camera_stop_acquisition:
+ *
+ * @camera: a #ArvCamera object
+ *
+ * Stops the video stream acquisition.
  */
 
 void
@@ -277,12 +281,12 @@ arv_camera_stop_acquisition (ArvCamera *camera)
 }
 
 /**
-   arv_camera_set_acquisition_mode:
-
-   @camera: a camera object
-   @mode: acquisition mode
-
-   Defines the acquisition mode.
+ * arv_camera_set_acquisition_mode:
+ *
+ * @camera: a #ArvCamera object
+ * @mode: acquisition mode
+ *
+ * Defines the acquisition mode.
  */
 
 
@@ -296,11 +300,12 @@ arv_camera_set_acquisition_mode (ArvCamera *camera, ArvAcquisitionMode mode)
 }
 
 /**
-  arv_camera_get_acquisition_mode:
-
-  @camera: a camera object
-
-  Retrieves the acquisition mode.
+ * arv_camera_get_acquisition_mode:
+ *
+ * @camera: a #ArvCamera object
+ * Return value: the acquisition mode.
+ *
+ * Retrieves the acquisition mode.
  */
 
 ArvAcquisitionMode
@@ -316,12 +321,12 @@ arv_camera_get_acquisition_mode (ArvCamera *camera)
 }
 
 /**
-   arv_camera_set_frame_rate: 
-
-   @camera: a camera object
-   @frame_rate: frame rate, in Hz²
-
-   Configures a fixed frame rate mode. Once acquisition start is triggered, the video stream will be acquired with the given frame rate.
+ * arv_camera_set_frame_rate: 
+ *
+ * @camera: a #ArvCamera object
+ * @frame_rate: frame rate, in Hz
+ *
+ * Configures a fixed frame rate mode. Once acquisition start is triggered, the video stream will be acquired with the given frame rate.
  */
 
 void
@@ -356,11 +361,10 @@ arv_camera_set_frame_rate (ArvCamera *camera, double frame_rate)
 }
 
 /**
-   arv_camera_get_frame_rate:
-
-   @camera: a camera object
-
-   Returns: The actual frame rate, in Hz.
+ * arv_camera_get_frame_rate:
+ *
+ * @camera: a #ArvCamera object
+ * Return value: the actual frame rate, in Hz.
  */
 
 double
@@ -379,12 +383,12 @@ arv_camera_get_frame_rate (ArvCamera *camera)
 }
 
 /**
-   arv_camera_set_trigger:
-
-   @camera: a camera object
-   @source: trigger source as string
-
-   Configures the camera in trigger mode. Typical values for source are "Line1" or "Line2". See the camera documentation for the allowed values. The activation is set to rising edge. It can be changed by accessing the underlying device object.
+ * arv_camera_set_trigger:
+ *
+ * @camera: a #ArvCamera object
+ * @source: trigger source as string
+ *
+ * Configures the camera in trigger mode. Typical values for source are "Line1" or "Line2". See the camera documentation for the allowed values. The activation is set to rising edge. It can be changed by accessing the underlying device object.
  */
 
 void
@@ -428,12 +432,12 @@ arv_camera_set_trigger (ArvCamera *camera, const char *source)
 }
 
 /**
-   arv_camera_set_exposure_time:
-
-   @camera: a camera object
-   @exposure_time_us: exposure time, in µs
-
-   Sets the exposure time. User should take care to set a value compatible with the desired frame rate.
+ * arv_camera_set_exposure_time:
+ *
+ * @camera: a #ArvCamera object
+ * @exposure_time_us: exposure time, in µs
+ *
+ * Sets the exposure time. User should take care to set a value compatible with the desired frame rate.
  */
 
 void
@@ -445,11 +449,10 @@ arv_camera_set_exposure_time (ArvCamera *camera, double exposure_time_us)
 }
 
 /**
-   arv_camera_get_exposure_time:
-
-   @camera: a camera object
-
-   Returns: The current exposure time, in µs.
+ * arv_camera_get_exposure_time:
+ *
+ * @camera: a #ArvCamera object
+ * Return value: the current exposure time, in µs.
  */
 
 double
@@ -463,12 +466,12 @@ arv_camera_get_exposure_time (ArvCamera *camera)
 /* Analog control */
 
 /**
-   arv_camera_set_gain:
-
-   @camera: a camera object
-   @gain: gain value
-
-   Sets the gain of the ADC converter.
+ * arv_camera_set_gain:
+ *
+ * @camera: a #ArvCamera object
+ * @gain: gain value
+ *
+ * Sets the gain of the ADC converter.
  */
 
 void
@@ -480,11 +483,10 @@ arv_camera_set_gain (ArvCamera *camera, gint64 gain)
 }
 
 /**
-   arv_camera_get_gain:
-
-   @camera: a camera object
-
-   Returns: The current gain setting.
+ * arv_camera_get_gain:
+ *
+ * @camera: a #ArvCamera object
+ * Return value: the current gain setting.
  */
 
 gint64
@@ -498,13 +500,12 @@ arv_camera_get_gain (ArvCamera *camera)
 /* Transport layer control */
 
 /**
-   arv_camera_get_payload:
-
-   @camera: a camera object
-   
-   Retrieves the size needed for the storage of an image. This value is used for the creation of the stream buffers.
-
-   Returns: The frame storage size, in bytes.
+ * arv_camera_get_payload:
+ *
+ * @camera: a camera object
+ * Return value: the frame storage size, in bytes.
+ * 
+ * Retrieves the size needed for the storage of an image. This value is used for the creation of the stream buffers.
  */
 
 guint
diff --git a/src/arvdevice.c b/src/arvdevice.c
index 9e24935..2208602 100644
--- a/src/arvdevice.c
+++ b/src/arvdevice.c
@@ -77,6 +77,15 @@ arv_device_write_register (ArvDevice *device, guint32 address, guint32 value)
 	return ARV_DEVICE_GET_CLASS (device)->write_register (device, address, value);
 }
 
+/**
+ * arv_device_get_genicam:
+ *
+ * @device: a device object
+ * Return value: (transfer none): the genicam interface.
+ *
+ * Retrieves the genicam interface of the given device.
+ */
+
 ArvGc *
 arv_device_get_genicam (ArvDevice *device)
 {
diff --git a/src/arvevaluator.c b/src/arvevaluator.c
index 4b682bf..e34eefc 100644
--- a/src/arvevaluator.c
+++ b/src/arvevaluator.c
@@ -1058,6 +1058,15 @@ arv_evaluator_set_int64_variable (ArvEvaluator *evaluator, const char *name, gin
 		   name, v_int64);
 }
 
+/**
+ * arv_evaluator_new:
+ *
+ * @expression: (allow-none): an evaluator expression
+ * Return value: a new #ArvEvaluator object.
+ *
+ * Creates a new #ArvEvaluator object. The syntax is described in the genicam standard specification.
+ */
+
 ArvEvaluator *
 arv_evaluator_new (const char *expression)
 {
diff --git a/src/arvgc.c b/src/arvgc.c
index 2dae7cf..705330f 100644
--- a/src/arvgc.c
+++ b/src/arvgc.c
@@ -279,6 +279,16 @@ arv_gc_parse_xml (ArvGc *genicam, const char *xml, size_t size)
 	xmlSAXUserParseMemory (&sax_handler, &state, xml, size);
 }
 
+/**
+ * arv_gc_get_node:
+ *
+ * @genicam: a #ArvGc object
+ * @name: node name
+ * Return value: (transfer none): a #ArvGcNode, null if not found.
+ *
+ * Retrieves a genicam node by name.
+ */
+
 ArvGcNode *
 arv_gc_get_node	(ArvGc *genicam, const char *name)
 {
@@ -287,6 +297,15 @@ arv_gc_get_node	(ArvGc *genicam, const char *name)
 	return g_hash_table_lookup (genicam->nodes, name);
 }
 
+/**
+ * arv_gc_get_device:
+ *
+ * @genicam: a #ArvGc object
+ * Return value: (transfer none): a #ArvDevice.
+ *
+ * Retrieves the device handled by this genicam interface. The device is used for register access.
+ */
+
 ArvDevice *
 arv_gc_get_device (ArvGc *genicam)
 {