Commit 7c105fb3 authored by philburk's avatar philburk

Add the JPortAudio JavaDocs to the PortAudio reference.

git-svn-id: https://subversion.assembla.com/svn/portaudio/portaudio/trunk@1869 0f58301d-fd10-0410-b4af-bbb618454e57
parent d179c94c
...@@ -89,6 +89,7 @@ INPUT = doc/src \ ...@@ -89,6 +89,7 @@ INPUT = doc/src \
FILE_PATTERNS = *.h \ FILE_PATTERNS = *.h \
*.c \ *.c \
*.cpp \ *.cpp \
*.java \
*.dox *.dox
RECURSIVE = YES RECURSIVE = YES
EXCLUDE = src/hostapi/wasapi/mingw-include EXCLUDE = src/hostapi/wasapi/mingw-include
......
...@@ -92,6 +92,7 @@ INPUT = doc/src \ ...@@ -92,6 +92,7 @@ INPUT = doc/src \
FILE_PATTERNS = *.h \ FILE_PATTERNS = *.h \
*.c \ *.c \
*.cpp \ *.cpp \
*.java \
*.dox *.dox
RECURSIVE = YES RECURSIVE = YES
EXCLUDE = src/hostapi/wasapi/mingw-include EXCLUDE = src/hostapi/wasapi/mingw-include
......
...@@ -6,10 +6,14 @@ ...@@ -6,10 +6,14 @@
@section java_draft DRAFT - IN PROGRESS @section java_draft DRAFT - IN PROGRESS
9/1/12 JPortAudio is very new and should be considered an "alpha" release. 9/4/12 JPortAudio is very new and should be considered an "alpha" release.
The building of JPortAudio will eventually be integrated into the Makefile as an optional build. The building of JPortAudio will eventually be integrated into the Makefile as an optional build.
Currently JPortAudio is only supported for Windows. Please contact us if you want to help with porting to Mac or Linux. Currently JPortAudio is only supported for Windows and Macintosh. Please contact us if you want to help with porting Linux.
For reference documentation of the JPortAudio API see: com.portaudio.PortAudio
For an example see: PlaySine.java
@section java_comp_windows Building JPortAudio on Windows @section java_comp_windows Building JPortAudio on Windows
......
...@@ -36,6 +36,11 @@ ...@@ -36,6 +36,11 @@
* license above. * license above.
*/ */
/** @file
@ingroup bindings_java
@brief A blocking read/write stream.
*/
package com.portaudio; package com.portaudio;
/** /**
...@@ -46,6 +51,8 @@ package com.portaudio; ...@@ -46,6 +51,8 @@ package com.portaudio;
* *
* To create one of these, call PortAudio.openStream(). * To create one of these, call PortAudio.openStream().
* *
* @see PortAudio
*
* @author Phil Burk * @author Phil Burk
* *
*/ */
......
...@@ -36,10 +36,17 @@ ...@@ -36,10 +36,17 @@
* license above. * license above.
*/ */
/** @file
@ingroup bindings_java
@brief Information about a JPortAudio device.
*/
package com.portaudio; package com.portaudio;
/** /**
* Equivalent to PaDeviceInfo * Equivalent to PaDeviceInfo
* @see PortAudio
* @see HostApiInfo
* @author Phil Burk * @author Phil Burk
* *
*/ */
......
...@@ -36,10 +36,17 @@ ...@@ -36,10 +36,17 @@
* license above. * license above.
*/ */
/** @file
@ingroup bindings_java
@brief Information about a JPortAudio Host API.
*/
package com.portaudio; package com.portaudio;
/** /**
* Equivalent to PaHostApiInfo * Equivalent to PaHostApiInfo
* @see PortAudio
* @see DeviceInfo
* @author Phil Burk * @author Phil Burk
* *
*/ */
......
...@@ -36,6 +36,11 @@ ...@@ -36,6 +36,11 @@
* license above. * license above.
*/ */
/** @file
@ingroup bindings_java
@brief Java wrapper for the PortAudio API.
*/
package com.portaudio; package com.portaudio;
/** /**
...@@ -52,6 +57,12 @@ package com.portaudio; ...@@ -52,6 +57,12 @@ package com.portaudio;
* garbage collection or synchronization. So only the blocking read/write mode * garbage collection or synchronization. So only the blocking read/write mode
* is supported. * is supported.
* *
* @see BlockingStream
* @see DeviceInfo
* @see HostApiInfo
* @see StreamInfo
* @see StreamParameters
*
* @author Phil Burk * @author Phil Burk
* *
*/ */
......
...@@ -36,10 +36,18 @@ ...@@ -36,10 +36,18 @@
* license above. * license above.
*/ */
/** @file
@ingroup bindings_java
@brief Information about a JPortAudio Stream.
*/
package com.portaudio; package com.portaudio;
/** /**
* Equivalent to PaStreamInfo * Equivalent to PaStreamInfo
* @see PortAudio
* @author Phil Burk * @author Phil Burk
* *
*/ */
......
...@@ -36,9 +36,15 @@ ...@@ -36,9 +36,15 @@
* license above. * license above.
*/ */
/** @file
@ingroup bindings_java
@brief Options to use when opening a stream.
*/
package com.portaudio; package com.portaudio;
/** /**
* Equivalent to PaStreamParameters * Equivalent to PaStreamParameters
* @see PortAudio
* @author Phil Burk * @author Phil Burk
* *
*/ */
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment