From e406f0371b34046e785339ce5d5519bffacdf93f Mon Sep 17 00:00:00 2001
From: Matthias Vogelgesang <matthias.vogelgesang@kit.edu>
Date: Wed, 5 Mar 2014 10:13:30 +0100
Subject: Fix annotations

---
 src/uca-ring-buffer.c | 34 +++++++++++++++++++++++++++++-----
 1 file changed, 29 insertions(+), 5 deletions(-)

(limited to 'src/uca-ring-buffer.c')

diff --git a/src/uca-ring-buffer.c b/src/uca-ring-buffer.c
index 26558d7..2334b7c 100644
--- a/src/uca-ring-buffer.c
+++ b/src/uca-ring-buffer.c
@@ -78,14 +78,13 @@ uca_ring_buffer_available (UcaRingBuffer *buffer)
 }
 
 /**
- * uca_ring_buffer_get_current_pointer:
+ * uca_ring_buffer_get_read_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.
+ * Get pointer to current read location. If no data is available, %NULL is
+ * returned.
  *
- * Return value: (transfer none): Pointer to data block
+ * Return value: (transfer none): Pointer to current read location
  */
 gpointer
 uca_ring_buffer_get_read_pointer (UcaRingBuffer *buffer)
@@ -102,6 +101,14 @@ uca_ring_buffer_get_read_pointer (UcaRingBuffer *buffer)
     return data;
 }
 
+/**
+ * uca_ring_buffer_get_write_pointer:
+ * @buffer: A #UcaRingBuffer object
+ *
+ * Get pointer to current write location.
+ *
+ * Return value: (transfer none): Pointer to current write location
+ */
 gpointer
 uca_ring_buffer_get_write_pointer (UcaRingBuffer *buffer)
 {
@@ -123,6 +130,14 @@ uca_ring_buffer_write_advance (UcaRingBuffer *buffer)
     buffer->priv->write_index++;
 }
 
+/**
+ * uca_ring_buffer_peek_pointer:
+ * @buffer: A #UcaRingBuffer object
+ *
+ * Get pointer to current write location without advancing.
+ *
+ * Return value: (transfer none): Pointer to current write location
+ */
 gpointer
 uca_ring_buffer_peek_pointer (UcaRingBuffer *buffer)
 {
@@ -132,6 +147,15 @@ uca_ring_buffer_peek_pointer (UcaRingBuffer *buffer)
     return ((guint8 *) priv->data) + ((priv->write_index % priv->n_blocks_total) * priv->block_size);
 }
 
+/**
+ * uca_ring_buffer_get_pointer:
+ * @buffer: A #UcaRingBuffer object
+ * @index: Block index of queried pointer
+ *
+ * Get pointer to read location identified by @index.
+ *
+ * Return value: (transfer none): Pointer to indexed read location
+ */
 gpointer
 uca_ring_buffer_get_pointer (UcaRingBuffer *buffer,
                              guint          index)
-- 
cgit v1.2.3