[aravis] doc: suppress gtk-doc warnings.
- From: Emmanuel Pacaud <emmanuel src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [aravis] doc: suppress gtk-doc warnings.
- Date: Mon, 17 Dec 2012 22:50:07 +0000 (UTC)
commit d5d1c82eb8a093051518f771d3d45001b9b89705
Author: Emmanuel Pacaud <emmanuel gnome org>
Date: Mon Dec 17 23:49:47 2012 +0100
doc: suppress gtk-doc warnings.
src/arvdevice.c | 9 ++++++---
src/arvdomnode.c | 6 ++++--
src/arvevaluator.c | 3 ++-
src/arvfakecamera.c | 1 +
src/arvfakedevice.c | 1 +
src/arvfakestream.c | 1 +
src/arvgc.c | 6 ++++--
src/arvgcnode.c | 3 ++-
src/arvgvstream.c | 1 +
src/arvinterface.c | 12 ++++++------
src/arvstream.c | 9 ++++++---
src/arvsystem.c | 3 ++-
12 files changed, 36 insertions(+), 19 deletions(-)
---
diff --git a/src/arvdevice.c b/src/arvdevice.c
index 38fa500..b5c79e2 100644
--- a/src/arvdevice.c
+++ b/src/arvdevice.c
@@ -60,11 +60,12 @@ arv_device_error_quark (void)
* @device: a #ArvDevice
* @callback: (scope call): a frame processing callback
* @user_data: (closure) user data for @callback
- * Return value: (transfer full): a new #ArvStream.
*
* Creates a new #ArvStream for video stream handling. See
* @ArvStreamCallback for details regarding the callback function.
*
+ * Return value: (transfer full): a new #ArvStream.
+ *
* Since: 0.2.0
*/
@@ -120,10 +121,11 @@ arv_device_write_register (ArvDevice *device, guint32 address, guint32 value, GE
/**
* arv_device_get_genicam:
* @device: a device object
- * Return value: (transfer none): the genicam interface.
*
* Retrieves the genicam interface of the given device.
*
+ * Return value: (transfer none): the genicam interface.
+ *
* Since: 0.2.0
*/
@@ -147,10 +149,11 @@ _get_genicam_xml (ArvDevice *device, size_t *size)
* arv_device_get_xml:
* @device: a #ArvDevice
* @size: placeholder for the returned data size (bytes)
- * Return value: a pointer to the Genicam XML data, owned by the device.
*
* Gets the Genicam XML data stored in the device memory.
*
+ * Return value: a pointer to the Genicam XML data, owned by the device.
+ *
* Since: 0.2.0
**/
diff --git a/src/arvdomnode.c b/src/arvdomnode.c
index f46a847..1603c77 100644
--- a/src/arvdomnode.c
+++ b/src/arvdomnode.c
@@ -159,9 +159,10 @@ static GObjectClass *parent_class = NULL;
/**
* arv_dom_node_get_node_name:
* @self: a #ArvDomNode
- * Return value: the node name.
*
* Gets the node name.
+ *
+ * Return value: the node name.
*/
const char*
@@ -180,9 +181,10 @@ arv_dom_node_get_node_name (ArvDomNode* self)
/**
* arv_dom_node_get_node_value:
* @self: a #ArvDomNode
- * Return value: the node value.
*
* Gets the node value.
+ *
+ * Return value: the node value.
*/
const char*
diff --git a/src/arvevaluator.c b/src/arvevaluator.c
index aac3b98..e042014 100644
--- a/src/arvevaluator.c
+++ b/src/arvevaluator.c
@@ -1100,9 +1100,10 @@ arv_evaluator_set_int64_variable (ArvEvaluator *evaluator, const char *name, gin
/**
* 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.
+ *
+ * Return value: a new #ArvEvaluator object.
*/
ArvEvaluator *
diff --git a/src/arvfakecamera.c b/src/arvfakecamera.c
index 1f7b9a4..9876876 100644
--- a/src/arvfakecamera.c
+++ b/src/arvfakecamera.c
@@ -313,6 +313,7 @@ arv_fake_camera_get_acquisition_status (ArvFakeCamera *camera)
/**
* arv_fake_camera_get_stream_address:
* @camera: a #ArvFakeCamera
+ *
* Return value: (transfer full): the data stream #GSocketAddress for this camera
*/
diff --git a/src/arvfakedevice.c b/src/arvfakedevice.c
index 88c3c86..0c935f9 100644
--- a/src/arvfakedevice.c
+++ b/src/arvfakedevice.c
@@ -100,6 +100,7 @@ arv_fake_device_write_register (ArvDevice *device, guint32 address, guint32 valu
/**
* arv_fake_device_get_fake_camera:
* @device: a fake device
+ *
* Return value: (transfer none): the #ArvFakeCamera used by this device instance.
*/
diff --git a/src/arvfakestream.c b/src/arvfakestream.c
index 70dd142..6328bd6 100644
--- a/src/arvfakestream.c
+++ b/src/arvfakestream.c
@@ -102,6 +102,7 @@ arv_fake_stream_thread (void *data)
* @camera: a #ArvFakeCamera
* @callback: (scope call): image processing callback
* @user_data: (closure): user data for @callback
+ *
* Return Value: (transfer full): a new #ArvStream.
*/
diff --git a/src/arvgc.c b/src/arvgc.c
index 5195d34..aac8f3e 100644
--- a/src/arvgc.c
+++ b/src/arvgc.c
@@ -209,9 +209,10 @@ arv_gc_create_element (ArvDomDocument *document, const char *tag_name)
* 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.
+ *
+ * Return value: (transfer none): a #ArvGcNode, null if not found.
*/
ArvGcNode *
@@ -226,9 +227,10 @@ arv_gc_get_node (ArvGc *genicam, const char *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.
+ *
+ * Return value: (transfer none): a #ArvDevice.
*/
ArvDevice *
diff --git a/src/arvgcnode.c b/src/arvgcnode.c
index 845a661..3e53b1a 100644
--- a/src/arvgcnode.c
+++ b/src/arvgcnode.c
@@ -45,9 +45,10 @@ static GObjectClass *parent_class = NULL;
/**
* arv_gc_node_get_genicam:
* @gc_node: a #ArvGcNode
- * Return value: (transfer none): the parent #ArvGc
*
* Retrieves the parent genicam document of @gc_node.
+ *
+ * Return value: (transfer none): the parent #ArvGc
*/
ArvGc *
diff --git a/src/arvgvstream.c b/src/arvgvstream.c
index 0630638..40707f9 100644
--- a/src/arvgvstream.c
+++ b/src/arvgvstream.c
@@ -704,6 +704,7 @@ arv_gv_stream_get_port (ArvGvStream *gv_stream)
* @user_data: (closure): user data for @callback
* @timestamp_tick_frequency: camera tick frequency for timestamping
* @packet_size: gvsp packet size, in bytes
+ *
* Return value: (transfer full): a new #ArvStream.
*/
diff --git a/src/arvinterface.c b/src/arvinterface.c
index 6a5fe18..e2fad72 100644
--- a/src/arvinterface.c
+++ b/src/arvinterface.c
@@ -53,7 +53,7 @@ arv_interface_clear_device_ids (ArvInterface *interface)
}
/**
- * arv_interface_update_device_list
+ * arv_interface_update_device_list:
* @interface: a #ArvInterface
*
* Updates the internal list of available devices. This may change the
@@ -73,7 +73,7 @@ arv_interface_update_device_list (ArvInterface *interface)
}
/**
- * arv_interface_get_n_devices
+ * arv_interface_get_n_devices:
* @interface: a #ArvInterface
*
* Queries the number of available devices on this interface. Prior to this
@@ -95,7 +95,7 @@ arv_interface_get_n_devices (ArvInterface *interface)
}
/**
- * arv_interface_get_device_id
+ * arv_interface_get_device_id:
* @interface: a #ArvInterface
* @index: device index
*
@@ -120,7 +120,7 @@ arv_interface_get_device_id (ArvInterface *interface, unsigned int index)
}
/**
- * arv_interface_get_device_physical_id
+ * arv_interface_get_device_physical_id:
* @interface: a #ArvInterface
* @index: device index
*
@@ -149,7 +149,7 @@ arv_interface_get_device_physical_id (ArvInterface *interface, unsigned int inde
}
/**
- * arv_interface_get_device_address
+ * arv_interface_get_device_address:
* @interface: a #ArvInterface
* @index: device index
*
@@ -177,7 +177,7 @@ arv_interface_get_device_address (ArvInterface *interface, unsigned int index)
}
/**
- * arv_interface_open_device
+ * arv_interface_open_device:
* @interface: a #ArvInterface
* @device_id: (allow-none): device unique id
*
diff --git a/src/arvstream.c b/src/arvstream.c
index 77d42d1..d61ba88 100644
--- a/src/arvstream.c
+++ b/src/arvstream.c
@@ -79,12 +79,13 @@ arv_stream_push_buffer (ArvStream *stream, ArvBuffer *buffer)
/**
* arv_stream_pop_buffer:
* @stream: a #ArvStream
- * Returns: (transfer full): a #ArvBuffer
*
* Pops a buffer from the output queue of @stream. The retrieved buffer
* may contain an invalid image. Caller should check the buffer status before using it.
* This function blocks until a buffer is available.
*
+ * Returns: (transfer full): a #ArvBuffer
+ *
* Since: 0.2.0
*/
@@ -99,12 +100,13 @@ arv_stream_pop_buffer (ArvStream *stream)
/**
* arv_stream_try_pop_buffer:
* @stream: a #ArvStream
- * Returns: (transfer full): a #ArvBuffer, NULL if no buffer is available.
*
* Pops a buffer from the output queue of @stream. The retrieved buffer
* may contain an invalid image. Caller should check the buffer status before using it.
* This is the non blocking version of pop_buffer.
*
+ * Returns: (transfer full): a #ArvBuffer, NULL if no buffer is available.
+ *
* Since: 0.2.0
*/
@@ -120,11 +122,12 @@ arv_stream_try_pop_buffer (ArvStream *stream)
* arv_stream_timeout_pop_buffer:
* @stream: a #ArvStream
* @timeout: timeout, in Âs
- * Returns: (transfer full): a #ArvBuffer, NULL if no buffer is available until the timeout occurs.
*
* Pops a buffer from the output queue of @stream, waiting no more than @timeout. The retrieved buffer
* may contain an invalid image. Caller should check the buffer status before using it.
*
+ * Returns: (transfer full): a #ArvBuffer, NULL if no buffer is available until the timeout occurs.
+ *
* Since: 0.2.0
*/
diff --git a/src/arvsystem.c b/src/arvsystem.c
index d660503..b438bea 100644
--- a/src/arvsystem.c
+++ b/src/arvsystem.c
@@ -169,9 +169,10 @@ arv_get_device_id (unsigned int index)
/**
* arv_open_device:
* @device_id: (allow-none): a device identifier string
- * Return value: (transfer full): a new #ArvDevice instance
*
* Open a device corresponding to the given identifier. A null string makes this function return the first available device.
+ *
+ * Return value: (transfer full): a new #ArvDevice instance
*/
ArvDevice *
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]