]> Repos - portaudio/commitdiff
corrected doc comment
authorrossb <rossb@0f58301d-fd10-0410-b4af-bbb618454e57>
Tue, 1 Feb 2011 11:18:16 +0000 (11:18 +0000)
committerrossb <rossb@0f58301d-fd10-0410-b4af-bbb618454e57>
Tue, 1 Feb 2011 11:18:16 +0000 (11:18 +0000)
src/common/pa_ringbuffer.c

index 282f4398d25d493442614b5c6e13430e19c18068..4a0c45ff0dc2010231bff241edb105281cd498e9 100644 (file)
@@ -145,7 +145,7 @@ ring_buffer_size_t PaUtil_AdvanceRingBufferWriteIndex( PaUtilRingBuffer *rbuf, r
 ** Get address of region(s) from which we can read data.
 ** If the region is contiguous, size2 will be zero.
 ** If non-contiguous, size2 will be the size of second region.
-** Returns room available to be written or elementCount, whichever is smaller.
+** Returns room available to be read or elementCount, whichever is smaller.
 */
 ring_buffer_size_t PaUtil_GetRingBufferReadRegions( PaUtilRingBuffer *rbuf, ring_buffer_size_t elementCount,
                                 void **dataPtr1, ring_buffer_size_t *sizePtr1,