diff options
| author | Matthias Vogelgesang <matthias.vogelgesang@kit.edu> | 2013-12-12 15:48:37 +0100 |
|---|---|---|
| committer | Matthias Vogelgesang <matthias.vogelgesang@kit.edu> | 2013-12-12 15:48:37 +0100 |
| commit | 8d07daf747c5061596072b3ecdfffbb2fcd11ef7 (patch) | |
| tree | cf828dcbf8726d5b8cfea0d16a5a85e6a55ec1c0 | |
| parent | d508de9c0bcbffb5efbcd26c7225c338fa50c342 (diff) | |
| download | uca-8d07daf747c5061596072b3ecdfffbb2fcd11ef7.tar.gz uca-8d07daf747c5061596072b3ecdfffbb2fcd11ef7.tar.bz2 uca-8d07daf747c5061596072b3ecdfffbb2fcd11ef7.tar.xz uca-8d07daf747c5061596072b3ecdfffbb2fcd11ef7.zip | |
Fix annotations and docstrings
| -rw-r--r-- | src/uca-plugin-manager.c | 6 | ||||
| -rw-r--r-- | src/uca-ring-buffer.c | 20 |
2 files changed, 23 insertions, 3 deletions
diff --git a/src/uca-plugin-manager.c b/src/uca-plugin-manager.c index 5013981..7cb65b4 100644 --- a/src/uca-plugin-manager.c +++ b/src/uca-plugin-manager.c @@ -30,7 +30,7 @@ * By default, any path listed in the %UCA_CAMERA_PATH environment variable is * added to the search path. * - * @Since: 1.1 + * Since: 1.1 */ #include <gio/gio.h> #include <gmodule.h> @@ -264,7 +264,7 @@ get_camera_type (UcaPluginManagerPrivate *priv, * Create a new camera instance with camera @name. * * Returns: (transfer full): A new #UcaCamera object. - * @Since: 1.2 + * Since: 1.2 */ UcaCamera * uca_plugin_manager_get_camerav (UcaPluginManager *manager, @@ -304,7 +304,7 @@ uca_plugin_manager_get_camerav (UcaPluginManager *manager, * Create a new camera instance with camera @name. * * Returns: (transfer full): A new #UcaCamera object. - * @Since: 1.2: Pass construction properties. + * Since: 1.2: Pass construction properties. */ UcaCamera * uca_plugin_manager_get_camera (UcaPluginManager *manager, diff --git a/src/uca-ring-buffer.c b/src/uca-ring-buffer.c index 2f5bfe1..40d7a25 100644 --- a/src/uca-ring-buffer.c +++ b/src/uca-ring-buffer.c @@ -68,6 +68,16 @@ uca_ring_buffer_get_block_size (UcaRingBuffer *buffer) return buffer->priv->block_size; } +/** + * uca_ring_buffer_get_current_pointer: + * @buffer: A #UcaRingBuffer object + * + * Get a pointer to the data for the block that is currently in use, that means + * the number uca_ring_buffer_proceed() has been called modulo the number of + * total blocks. + * + * Return value: (transfer none): Pointer to data block + */ gpointer uca_ring_buffer_get_current_pointer (UcaRingBuffer *buffer) { @@ -87,6 +97,16 @@ uca_ring_buffer_set_current_pointer (UcaRingBuffer *buffer, buffer->priv->current_index = index; } +/** + * uca_ring_buffer_get_pointer: + * @buffer: A #UcaRingBuffer object + * @index: Block index to get the pointer for + * + * Get a pointer to the data for @index block. @index must be less than + * :num-blocks. + * + * Return value: (transfer none): Pointer to data block + */ gpointer uca_ring_buffer_get_pointer (UcaRingBuffer *buffer, guint index) |