Add the JPortAudio JavaDocs to the PortAudio reference.

diff --git a/Doxyfile b/Doxyfile
index 6680898497d24f9f1f75ae65e81f2cae55ae5361..69c5af377221f877abba86d1c411600bc188da23 100644 (file)
--- 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 b9fa931c6af9ed66938439278ec2a09a3b7d47ec..0bfb0daffbd38916f2f64ab95b2be186afb01c22 100644 (file)
--- a/Doxyfile.developer
+++ b/Doxyfile.developer
@@ -92,6 +92,7 @@ INPUT                  = doc/src \
 FILE_PATTERNS          = *.h \\r
                          *.c \\r
                          *.cpp \\r
+                         *.java \\r
                          *.dox\r
 RECURSIVE              = YES\r
 EXCLUDE                = src/hostapi/wasapi/mingw-include\r

diff --git a/bindings/java/jportaudio.dox b/bindings/java/jportaudio.dox
index 4d88d2a95298d0113116ab4f70587d48ff4e0550..6fb4c198311d852fadc2cb501226fcffa428f90e 100644 (file)
--- a/bindings/java/jportaudio.dox
+++ b/bindings/java/jportaudio.dox
@@ -6,10 +6,14 @@
 \r
 @section java_draft DRAFT - IN PROGRESS\r
 \r
-9/1/12 JPortAudio is very new and should be considered an "alpha" release.\r
+9/4/12 JPortAudio is very new and should be considered an "alpha" release.\r
 The building of JPortAudio will eventually be integrated into the Makefile as an optional build.\r
 \r
-Currently JPortAudio is only supported for Windows. Please contact us if you want to help with porting to Mac or Linux.\r
+Currently JPortAudio is only supported for Windows and Macintosh. Please contact us if you want to help with porting Linux.\r
+\r
+For reference documentation of the JPortAudio API see: com.portaudio.PortAudio\r
+\r
+For an example see: PlaySine.java\r
 \r
 @section java_comp_windows Building JPortAudio on Windows\r
 \r

diff --git a/bindings/java/jportaudio/src/com/portaudio/BlockingStream.java b/bindings/java/jportaudio/src/com/portaudio/BlockingStream.java
index 721c36341a9a12f75e16b9631ead38a82c5ef7a1..4c249abea3f5978f5303f78a6c2e89e83a161785 100644 (file)
--- 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 9c7966b68ee9a4a1c6112e7892df3a16fc8c6192..1c4682ec50732882a9d657c26d5b6ab19990691a 100644 (file)
--- 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 74a8235c8fc3a9f5e2b1367506028993ed3c9e2d..dc2cdceb1bcc5a840d29ac97000e2ed26e4a8a06 100644 (file)
--- 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 789004e4aae191caaeb2763c526ebfbf6628f38c..41b3c67b58f9877ddbb4fe040ec32a6fe9a67829 100644 (file)
--- 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 fdd0207646a2956d961ad9104c8a4306199d21ee..685f94d5d53fc9c6871b9cac7817e5accd4e1e65 100644 (file)
--- 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 845da2c7a67bb97c058e94a6cd53a7277db7cb9f..707dab5ecf2e3becf50ce5afdb2214ad02ae3ad2 100644 (file)
--- 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
  *
  */