From 8d07daf747c5061596072b3ecdfffbb2fcd11ef7 Mon Sep 17 00:00:00 2001 From: Matthias Vogelgesang Date: Thu, 12 Dec 2013 15:48:37 +0100 Subject: Fix annotations and docstrings --- src/uca-ring-buffer.c | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) (limited to 'src/uca-ring-buffer.c') 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) -- cgit v1.2.3