From 8f3712c704c2c0cb2896668ab47f9e6364faff5e Mon Sep 17 00:00:00 2001 From: Julien Gouesse Date: Sun, 9 Apr 2023 16:02:46 +0200 Subject: Fixes the Java documentation of ardor3d-audio-joal --- .../java/com/ardor3d/audio/joal/ChannelJOAL.java | 3 ++- .../java/com/ardor3d/audio/joal/LibraryJOAL.java | 29 ++++++++++++---------- .../java/com/ardor3d/audio/joal/SourceJOAL.java | 2 +- 3 files changed, 19 insertions(+), 15 deletions(-) diff --git a/ardor3d-audio-joal/src/main/java/com/ardor3d/audio/joal/ChannelJOAL.java b/ardor3d-audio-joal/src/main/java/com/ardor3d/audio/joal/ChannelJOAL.java index baa6a7f..2ebdead 100644 --- a/ardor3d-audio-joal/src/main/java/com/ardor3d/audio/joal/ChannelJOAL.java +++ b/ardor3d-audio-joal/src/main/java/com/ardor3d/audio/joal/ChannelJOAL.java @@ -61,7 +61,7 @@ import com.ardor3d.audio.SoundSystemConfig; * You acknowledge that this software is not designed or intended for use in the * design, construction, operation or maintenance of any nuclear facility. *


- * SoundSystem LibraryJOAL License:

+ * SoundSystem LibraryJOAL License:

* * You are free to use this library for any purpose, commercial or otherwise. * You may modify this library or source code, and distribute it any way you @@ -478,6 +478,7 @@ public class ChannelJOAL extends Channel /** * Returns the number of milliseconds of audio contained in specified buffer. + * @param alBufferi buffer identifier * @return milliseconds, or 0 if unable to calculate. */ public float millisInBuffer( int alBufferi ) diff --git a/ardor3d-audio-joal/src/main/java/com/ardor3d/audio/joal/LibraryJOAL.java b/ardor3d-audio-joal/src/main/java/com/ardor3d/audio/joal/LibraryJOAL.java index 95b2d6d..1543a87 100644 --- a/ardor3d-audio-joal/src/main/java/com/ardor3d/audio/joal/LibraryJOAL.java +++ b/ardor3d-audio-joal/src/main/java/com/ardor3d/audio/joal/LibraryJOAL.java @@ -71,7 +71,7 @@ import com.ardor3d.audio.Source; * You acknowledge that this software is not designed or intended for use in the * design, construction, operation or maintenance of any nuclear facility. *


- * SoundSystem LibraryJOAL License:

+ * SoundSystem LibraryJOAL License:

* * You are free to use this library for any purpose, commercial or otherwise. * You may modify this library or source code, and distribute it any way you @@ -138,15 +138,18 @@ public class LibraryJOAL extends Library */ private static boolean alPitchSupported = true; -/** - * Constructor: Instantiates the source map, buffer map and listener - * information. Also sets the library type to - * SoundSystemConfig.LIBRARY_OPENAL - */ + /** + * Constructor: Instantiates the source map, buffer map and listener + * information.Also sets the library type to SoundSystemConfig.LIBRARY_OPENAL + * + * + * + * @throws com.ardor3d.audio.SoundSystemException if the sound system cannot be initialized + */ public LibraryJOAL() throws SoundSystemException { super(); - ALBufferMap = new HashMap(); + ALBufferMap = new HashMap<>(); reverseByteOrder = true; } @@ -357,13 +360,13 @@ public class LibraryJOAL extends Library // Make sure the buffer map exists: if( bufferMap == null ) { - bufferMap = new HashMap(); + bufferMap = new HashMap<>(); importantMessage( "Buffer Map was null in method 'loadSound'" ); } // Make sure the OpenAL buffer map exists: if( ALBufferMap == null ) { - ALBufferMap = new HashMap(); + ALBufferMap = new HashMap<>(); importantMessage( "Open AL Buffer Map was null in method" + "'loadSound'" ); } @@ -481,13 +484,13 @@ public class LibraryJOAL extends Library // Make sure the buffer map exists: if( bufferMap == null ) { - bufferMap = new HashMap(); + bufferMap = new HashMap<>(); importantMessage( "Buffer Map was null in method 'loadSound'" ); } // Make sure the OpenAL buffer map exists: if( ALBufferMap == null ) { - ALBufferMap = new HashMap(); + ALBufferMap = new HashMap<>(); importantMessage( "Open AL Buffer Map was null in method" + "'loadSound'" ); } @@ -799,13 +802,13 @@ public class LibraryJOAL extends Library // Make sure the buffer map exists: if( bufferMap == null ) { - bufferMap = new HashMap(); + bufferMap = new HashMap<>(); importantMessage( "Buffer Map was null in method 'copySources'" ); } // Make sure the OpenAL buffer map exists: if( ALBufferMap == null ) { - ALBufferMap = new HashMap(); + ALBufferMap = new HashMap<>(); importantMessage( "Open AL Buffer Map was null in method" + "'copySources'" ); } diff --git a/ardor3d-audio-joal/src/main/java/com/ardor3d/audio/joal/SourceJOAL.java b/ardor3d-audio-joal/src/main/java/com/ardor3d/audio/joal/SourceJOAL.java index 34bc63b..578901a 100644 --- a/ardor3d-audio-joal/src/main/java/com/ardor3d/audio/joal/SourceJOAL.java +++ b/ardor3d-audio-joal/src/main/java/com/ardor3d/audio/joal/SourceJOAL.java @@ -61,7 +61,7 @@ import com.ardor3d.math.Vector3; * You acknowledge that this software is not designed or intended for use in the * design, construction, operation or maintenance of any nuclear facility. *


- * SoundSystem LibraryJOAL License:

+ * SoundSystem LibraryJOAL License:

* * You are free to use this library for any purpose, commercial or otherwise. * You may modify this library or source code, and distribute it any way you -- cgit v1.2.3