From: rossb <rossb@0f58301d-fd10-0410-b4af-bbb618454e57>
Date: Sun, 24 Oct 2010 10:21:35 +0000 (+0000)
Subject: clarified some doc comments in pa_ringbuffer.h including one typo that said <write... 
X-Git-Tag: pa_stable_v19_20110326_r1647~81
X-Git-Url: https://andrewgundersen.net/repos?a=commitdiff_plain;h=0fec134103d5667c5d11468f30c2ae57fbb64e25;p=portaudio

clarified some doc comments in pa_ringbuffer.h including one typo that said <write> instead or <read>
---

diff --git a/src/common/pa_ringbuffer.c b/src/common/pa_ringbuffer.c
index d4801bf..282f439 100644
--- a/src/common/pa_ringbuffer.c
+++ b/src/common/pa_ringbuffer.c
@@ -91,7 +91,7 @@ ring_buffer_size_t PaUtil_GetRingBufferWriteAvailable( PaUtilRingBuffer *rbuf )
 }
 
 /***************************************************************************
-** Clear buffer. Should only be called when buffer is NOT being read. */
+** Clear buffer. Should only be called when buffer is NOT being read or written. */
 void PaUtil_FlushRingBuffer( PaUtilRingBuffer *rbuf )
 {
     rbuf->writeIndex = rbuf->readIndex = 0;
diff --git a/src/common/pa_ringbuffer.h b/src/common/pa_ringbuffer.h
index 89460e0..f8318d8 100644
--- a/src/common/pa_ringbuffer.h
+++ b/src/common/pa_ringbuffer.h
@@ -98,13 +98,13 @@ typedef struct PaUtilRingBuffer
     char  *buffer;    /**< Pointer to the buffer containing the actual data. */
 }PaUtilRingBuffer;
 
-/** Initialize Ring Buffer.
+/** Initialize Ring Buffer to empty state ready to have elements written to it.
 
  @param rbuf The ring buffer.
 
  @param elementSizeBytes The size of a single data element in bytes.
 
- @param elementCount The number of elements in the buffer (must be power of 2).
+ @param elementCount The number of elements in the buffer (must be a power of 2).
 
  @param dataPtr A pointer to a previously allocated area where the data
  will be maintained.  It must be elementCount*elementSizeBytes long.
@@ -113,7 +113,7 @@ typedef struct PaUtilRingBuffer
 */
 ring_buffer_size_t PaUtil_InitializeRingBuffer( PaUtilRingBuffer *rbuf, ring_buffer_size_t elementSizeBytes, ring_buffer_size_t elementCount, void *dataPtr );
 
-/** Clear buffer. Should only be called when buffer is NOT being read.
+/** Reset buffer to empty. Should only be called when buffer is NOT being read or written.
 
  @param rbuf The ring buffer.
 */
@@ -193,7 +193,7 @@ ring_buffer_size_t PaUtil_GetRingBufferWriteRegions( PaUtilRingBuffer *rbuf, rin
 */
 ring_buffer_size_t PaUtil_AdvanceRingBufferWriteIndex( PaUtilRingBuffer *rbuf, ring_buffer_size_t elementCount );
 
-/** Get address of region(s) from which we can write data.
+/** Get address of region(s) from which we can read data.
 
  @param rbuf The ring buffer.