From: philburk <philburk@0f58301d-fd10-0410-b4af-bbb618454e57>
Date: Tue, 4 Sep 2012 23:38:34 +0000 (+0000)
Subject: Add the JPortAudio JavaDocs to the PortAudio reference.
X-Git-Tag: pa_stable_v19_20140130_r1919~35
X-Git-Url: https://andrewgundersen.net/repos?a=commitdiff_plain;h=3291a153e1640c862e086c1b4a7b1505801dd1bb;p=portaudio

Add the JPortAudio JavaDocs to the PortAudio reference.
---

diff --git a/Doxyfile b/Doxyfile
index 6680898..69c5af3 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -89,6 +89,7 @@ INPUT                  = doc/src \
 FILE_PATTERNS          = *.h \
                          *.c \
                          *.cpp \
+                         *.java \
                          *.dox
 RECURSIVE              = YES
 EXCLUDE                = src/hostapi/wasapi/mingw-include
diff --git a/Doxyfile.developer b/Doxyfile.developer
index b9fa931..0bfb0da 100644
--- a/Doxyfile.developer
+++ b/Doxyfile.developer
@@ -92,6 +92,7 @@ INPUT                  = doc/src \
 FILE_PATTERNS          = *.h \
                          *.c \
                          *.cpp \
+                         *.java \
                          *.dox
 RECURSIVE              = YES
 EXCLUDE                = src/hostapi/wasapi/mingw-include
diff --git a/bindings/java/jportaudio.dox b/bindings/java/jportaudio.dox
index 4d88d2a..6fb4c19 100644
--- a/bindings/java/jportaudio.dox
+++ b/bindings/java/jportaudio.dox
@@ -6,10 +6,14 @@
 
 @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.
 
-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
 
diff --git a/bindings/java/jportaudio/src/com/portaudio/BlockingStream.java b/bindings/java/jportaudio/src/com/portaudio/BlockingStream.java
index 721c363..4c249ab 100644
--- a/bindings/java/jportaudio/src/com/portaudio/BlockingStream.java
+++ b/bindings/java/jportaudio/src/com/portaudio/BlockingStream.java
@@ -36,6 +36,11 @@
  * license above.
  */
 
+/** @file
+ @ingroup bindings_java
+
+ @brief A blocking read/write stream.
+*/
 package com.portaudio;
 
 /**
@@ -46,6 +51,8 @@ package com.portaudio;
  * 
  * To create one of these, call PortAudio.openStream().
  * 
+ * @see PortAudio
+ * 
  * @author Phil Burk
  * 
  */
diff --git a/bindings/java/jportaudio/src/com/portaudio/DeviceInfo.java b/bindings/java/jportaudio/src/com/portaudio/DeviceInfo.java
index 9c7966b..1c4682e 100644
--- a/bindings/java/jportaudio/src/com/portaudio/DeviceInfo.java
+++ b/bindings/java/jportaudio/src/com/portaudio/DeviceInfo.java
@@ -36,10 +36,17 @@
  * license above.
  */
 
+/** @file
+ @ingroup bindings_java
+
+ @brief Information about a JPortAudio device.
+*/
 package com.portaudio;
 
 /**
  * Equivalent to PaDeviceInfo
+ * @see PortAudio
+ * @see HostApiInfo
  * @author Phil Burk
  *
  */
diff --git a/bindings/java/jportaudio/src/com/portaudio/HostApiInfo.java b/bindings/java/jportaudio/src/com/portaudio/HostApiInfo.java
index 74a8235..dc2cdce 100644
--- a/bindings/java/jportaudio/src/com/portaudio/HostApiInfo.java
+++ b/bindings/java/jportaudio/src/com/portaudio/HostApiInfo.java
@@ -36,10 +36,17 @@
  * license above.
  */
 
+/** @file
+ @ingroup bindings_java
+
+ @brief Information about a JPortAudio Host API.
+*/
 package com.portaudio;
 
 /**
  * Equivalent to PaHostApiInfo
+ * @see PortAudio
+ * @see DeviceInfo
  * @author Phil Burk
  *
  */
diff --git a/bindings/java/jportaudio/src/com/portaudio/PortAudio.java b/bindings/java/jportaudio/src/com/portaudio/PortAudio.java
index 789004e..41b3c67 100644
--- a/bindings/java/jportaudio/src/com/portaudio/PortAudio.java
+++ b/bindings/java/jportaudio/src/com/portaudio/PortAudio.java
@@ -36,6 +36,11 @@
  * license above.
  */
 
+/** @file
+ @ingroup bindings_java
+
+ @brief Java wrapper for the PortAudio API.
+*/
 package com.portaudio;
 
 /**
@@ -52,6 +57,12 @@ package com.portaudio;
  * garbage collection or synchronization. So only the blocking read/write mode
  * is supported.
  * 
+ * @see BlockingStream
+ * @see DeviceInfo
+ * @see HostApiInfo
+ * @see StreamInfo
+ * @see StreamParameters
+ * 
  * @author Phil Burk
  * 
  */
diff --git a/bindings/java/jportaudio/src/com/portaudio/StreamInfo.java b/bindings/java/jportaudio/src/com/portaudio/StreamInfo.java
index fdd0207..685f94d 100644
--- a/bindings/java/jportaudio/src/com/portaudio/StreamInfo.java
+++ b/bindings/java/jportaudio/src/com/portaudio/StreamInfo.java
@@ -36,10 +36,18 @@
  * license above.
  */
 
+
+/** @file
+ @ingroup bindings_java
+
+ @brief Information about a JPortAudio Stream.
+*/
+
 package com.portaudio;
 
 /**
  * Equivalent to PaStreamInfo
+ * @see PortAudio
  * @author Phil Burk
  *
  */
diff --git a/bindings/java/jportaudio/src/com/portaudio/StreamParameters.java b/bindings/java/jportaudio/src/com/portaudio/StreamParameters.java
index 845da2c..707dab5 100644
--- a/bindings/java/jportaudio/src/com/portaudio/StreamParameters.java
+++ b/bindings/java/jportaudio/src/com/portaudio/StreamParameters.java
@@ -36,9 +36,15 @@
  * license above.
  */
 
+/** @file
+ @ingroup bindings_java
+
+ @brief Options to use when opening a stream.
+*/
 package com.portaudio;
 /**
  * Equivalent to PaStreamParameters
+ * @see PortAudio
  * @author Phil Burk
  *
  */