From: philburk <philburk@0f58301d-fd10-0410-b4af-bbb618454e57>
Date: Sun, 7 Oct 2012 19:00:11 +0000 (+0000)
Subject: Add comment about including source code for ring buffer in app.
X-Git-Tag: pa_stable_v19_20140130_r1919~31
X-Git-Url: https://andrewgundersen.net/repos?a=commitdiff_plain;h=042f67383cef7b6d286c9d5ea6f6122d8fcf6671;p=portaudio

Add comment about including source code for ring buffer in app.
---

diff --git a/src/common/pa_ringbuffer.h b/src/common/pa_ringbuffer.h
index 004fdd5..9edba0d 100644
--- a/src/common/pa_ringbuffer.h
+++ b/src/common/pa_ringbuffer.h
@@ -65,6 +65,9 @@
  The memory area used to store the buffer elements must be allocated by 
  the client prior to calling PaUtil_InitializeRingBuffer() and must outlive
  the use of the ring buffer.
+ 
+ @note The ring buffer functions are not normally exposed in the PortAudio libraries. 
+ If you want to call them then you will need to add pa_ringbuffer.c to your application source code.
 */
 
 #if defined(__APPLE__)