Documentation updates for release 4.0.3.

diff --git a/doc/doxygen/apinotes.txt b/doc/doxygen/apinotes.txt
index 73e473e1abb7afb776a9ec80f209d4151e487a50..1d369b64c51989cdf05bdcf0737de5f9137a108a 100644 (file)
--- a/doc/doxygen/apinotes.txt
+++ b/doc/doxygen/apinotes.txt
@@ -22,12 +22,16 @@ The RtAudio Jack support can be compiled on Macintosh OS-X systems, as well as i
 
 \section windowsds Windows (DirectSound):
 
+The \c configure script provides support for the MinGW compiler.  DirectSound support is specified with the "--with-ds" flag.
+
 In order to compile RtAudio under Windows for the DirectSound API, you must have the header and source files for DirectSound version 5.0 or higher.  As far as I know, there is no DirectSoundCapture support for Windows NT.  Audio output latency with DirectSound can be reasonably good, especially since RtAudio version 3.0.2.  Input audio latency still tends to be bad but better since version 3.0.2.  RtAudio was originally developed with Visual C++ version 6.0 but has been tested with .NET.
 
 The DirectSound version of RtAudio can be compiled with or without the UNICODE preprocessor definition.
 
 \section windowsasio Windows (ASIO):
 
+ASIO support using MinGW and the \c configure script is specified with the "--with-asio" flag.
+
 The Steinberg ASIO audio API allows only a single device driver to be loaded and accessed at a time.  ASIO device drivers must be supplied by audio hardware manufacturers, though ASIO emulation is possible on top of systems with DirectSound drivers.  The <I>numberOfBuffers</I> parameter to the RtAudio::openStream() function has no affect in this implementation.
 
 A number of ASIO source and header files are required for use with RtAudio.  Specifically, an RtAudio project must include the following files: <TT>asio.h,cpp; asiodrivers.h,cpp; asiolist.h,cpp; asiodrvr.h; asiosys.h; ginclude.h; iasiodrv.h; iasiothiscallresolver.h,cpp</TT>.  The Visual C++ projects found in <TT>/tests/Windows/</TT> compile both ASIO and DirectSound support.

diff --git a/doc/doxygen/compiling.txt b/doc/doxygen/compiling.txt
index 4cc769f7e486bf5cbdce4f8896f46cf5f6bbd1a8..d7b9a2976198b10d3910e4226354c74b4ab9e479 100644 (file)
--- a/doc/doxygen/compiling.txt
+++ b/doc/doxygen/compiling.txt
@@ -2,7 +2,7 @@
 
 \section debug Debugging
 
-If you are having problems getting RtAudio to run on your system, make sure to pass a value of \e true to the RtAudio::showWarnings() function (this is the default setting).  A variety of warning messages will be displayed which may help in determining the problem.  Also, try using the programs included in the <tt>tests</tt> directory.  The program <tt>probe</tt> displays the queried capabilities of all hardware devices found for all APIs compiled.  When using the ALSA API, further information can be displayed by defining the preprocessor definition __RTAUDIO_DEBUG__.
+If you are having problems getting RtAudio to run on your system, make sure to pass a value of \e true to the RtAudio::showWarnings() function (this is the default setting).  A variety of warning messages will be displayed which may help in determining the problem.  Also, try using the programs included in the <tt>tests</tt> directory.  The program <tt>audioprobe</tt> displays the queried capabilities of all hardware devices found for all APIs compiled.  When using the ALSA API, further information can be displayed by defining the preprocessor definition __RTAUDIO_DEBUG__.
 
 \section compile Compiling
 
@@ -24,7 +24,7 @@ In order to compile RtAudio for a specific OS and audio API, it is necessary to
   <TD>RtApiAlsa</TD>
   <TD>__LINUX_ALSA__</TD>
   <TD><TT>asound, pthread</TT></TD>
-  <TD><TT>g++ -Wall -D__LINUX_ALSA__ -o probe probe.cpp RtAudio.cpp -lasound -lpthread</TT></TD>
+  <TD><TT>g++ -Wall -D__LINUX_ALSA__ -o audioprobe audioprobe.cpp RtAudio.cpp -lasound -lpthread</TT></TD>
 </TR>
 <TR>
   <TD>Linux</TD>
@@ -32,7 +32,7 @@ In order to compile RtAudio for a specific OS and audio API, it is necessary to
   <TD>RtApiOss</TD>
   <TD>__LINUX_OSS__</TD>
   <TD><TT>pthread</TT></TD>
-  <TD><TT>g++ -Wall -D__LINUX_OSS__ -o probe probe.cpp RtAudio.cpp -lpthread</TT></TD>
+  <TD><TT>g++ -Wall -D__LINUX_OSS__ -o audioprobe audioprobe.cpp RtAudio.cpp -lpthread</TT></TD>
 </TR>
 <TR>
   <TD>Linux or Macintosh OS-X</TD>
@@ -40,7 +40,7 @@ In order to compile RtAudio for a specific OS and audio API, it is necessary to
   <TD>RtApiJack</TD>
   <TD>__UNIX_JACK__</TD>
   <TD><TT>jack, pthread</TT></TD>
-  <TD><TT>g++ -Wall -D__UNIX_JACK__ -o probe probe.cpp RtAudio.cpp `pkg-config --cflags --libs jack` -lpthread</TT></TD>
+  <TD><TT>g++ -Wall -D__UNIX_JACK__ -o audioprobe audioprobe.cpp RtAudio.cpp `pkg-config --cflags --libs jack` -lpthread</TT></TD>
 </TR>
 
 <TR>
@@ -49,7 +49,7 @@ In order to compile RtAudio for a specific OS and audio API, it is necessary to
   <TD>RtApiCore</TD>
   <TD>__MACOSX_CORE__</TD>
   <TD><TT>pthread, CoreAudio</TT></TD>
-  <TD><TT>g++ -Wall -D__MACOSX_CORE__ -o probe probe.cpp RtAudio.cpp -framework CoreAudio -lpthread</TT></TD>
+  <TD><TT>g++ -Wall -D__MACOSX_CORE__ -o audioprobe audioprobe.cpp RtAudio.cpp -framework CoreAudio -lpthread</TT></TD>
 </TR>
 <TR>
   <TD>Windows</TD>
@@ -70,7 +70,7 @@ In order to compile RtAudio for a specific OS and audio API, it is necessary to
 </TABLE>
 <P>
 
-The example compiler statements above could be used to compile the <TT>probe.cpp</TT> example file, assuming that <TT>probe.cpp</TT>, <TT>RtAudio.h</TT>, <tt>RtError.h</tt>, and <TT>RtAudio.cpp</TT> all exist in the same directory.
+The example compiler statements above could be used to compile the <TT>audioprobe.cpp</TT> example file, assuming that <TT>audioprobe.cpp</TT>, <TT>RtAudio.h</TT>, <tt>RtError.h</tt>, and <TT>RtAudio.cpp</TT> all exist in the same directory.
 
 
 */

diff --git a/doc/doxygen/tutorial.txt b/doc/doxygen/tutorial.txt
index 2ab0f1f05bc8ca22ac841a9f2ee45433d47065ea..89bb94892f8b673104db408be374b94ec56d2acf 100644 (file)
--- a/doc/doxygen/tutorial.txt
+++ b/doc/doxygen/tutorial.txt
@@ -32,7 +32,7 @@ Devices are now re-enumerated every time the RtAudio::getDeviceCount(), RtAudio:
 
 \section download Download
 
-Latest Release (21 August 2007): <A href="http://music.mcgill.ca/~gary/rtaudio/release/rtaudio-4.0.2.tar.gz">Version 4.0.2</A>
+Latest Release (7 December 2007): <A href="http://music.mcgill.ca/~gary/rtaudio/release/rtaudio-4.0.3.tar.gz">Version 4.0.3</A>
 
 \section documentation Documentation Links