From 2981aac62b42a0d92719f1cd7365892da3071be1 Mon Sep 17 00:00:00 2001 From: Julien Gouesse Date: Sun, 9 Apr 2023 17:30:30 +0200 Subject: Fixes many errors in the Java documentation of ardor3d-audio --- .../src/main/java/com/ardor3d/audio/Channel.java | 2 +- .../main/java/com/ardor3d/audio/CommandObject.java | 2 +- .../main/java/com/ardor3d/audio/CommandThread.java | 2 +- .../main/java/com/ardor3d/audio/FilenameURL.java | 2 +- .../src/main/java/com/ardor3d/audio/ICodec.java | 2 +- .../src/main/java/com/ardor3d/audio/Library.java | 2 +- .../main/java/com/ardor3d/audio/ListenerData.java | 2 +- .../main/java/com/ardor3d/audio/SimpleThread.java | 2 +- .../main/java/com/ardor3d/audio/SoundBuffer.java | 2 +- .../main/java/com/ardor3d/audio/SoundSystem.java | 2 +- .../java/com/ardor3d/audio/SoundSystemConfig.java | 2 +- .../com/ardor3d/audio/SoundSystemException.java | 2 +- .../java/com/ardor3d/audio/SoundSystemLogger.java | 2 +- .../src/main/java/com/ardor3d/audio/Source.java | 2 +- .../main/java/com/ardor3d/audio/StreamThread.java | 2 +- .../java/com/ardor3d/audio/codecs/CodecJOrbis.java | 2 +- .../com/ardor3d/audio/sampled/AudioFormat.java | 54 +++++++++++----------- 17 files changed, 43 insertions(+), 43 deletions(-) diff --git a/ardor3d-audio/src/main/java/com/ardor3d/audio/Channel.java b/ardor3d-audio/src/main/java/com/ardor3d/audio/Channel.java index 4e196b0..611cdda 100644 --- a/ardor3d-audio/src/main/java/com/ardor3d/audio/Channel.java +++ b/ardor3d-audio/src/main/java/com/ardor3d/audio/Channel.java @@ -20,7 +20,7 @@ import com.ardor3d.audio.sampled.AudioFormat; * ones. For consistant naming conventions, each sub-class should have the * name prefix "Channel". *

- * SoundSystem License:

+ * SoundSystem 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 * like, provided the following conditions are met: diff --git a/ardor3d-audio/src/main/java/com/ardor3d/audio/CommandObject.java b/ardor3d-audio/src/main/java/com/ardor3d/audio/CommandObject.java index 84e82c3..f7e738c 100644 --- a/ardor3d-audio/src/main/java/com/ardor3d/audio/CommandObject.java +++ b/ardor3d-audio/src/main/java/com/ardor3d/audio/CommandObject.java @@ -16,7 +16,7 @@ package com.ardor3d.audio; * and executed in the background, so it is unlikely that the user will ever * need to use this class. *

- * SoundSystem License:

+ * SoundSystem 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 * like, provided the following conditions are met: diff --git a/ardor3d-audio/src/main/java/com/ardor3d/audio/CommandThread.java b/ardor3d-audio/src/main/java/com/ardor3d/audio/CommandThread.java index 11ae506..b3c005d 100644 --- a/ardor3d-audio/src/main/java/com/ardor3d/audio/CommandThread.java +++ b/ardor3d-audio/src/main/java/com/ardor3d/audio/CommandThread.java @@ -24,7 +24,7 @@ package com.ardor3d.audio; * NOTE: The command thread is created automatically by the sound system, so it * is unlikely that the user would ever need to use this class. *

- * SoundSystem License:

+ * SoundSystem 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 * like, provided the following conditions are met: diff --git a/ardor3d-audio/src/main/java/com/ardor3d/audio/FilenameURL.java b/ardor3d-audio/src/main/java/com/ardor3d/audio/FilenameURL.java index 8fcb116..93019fa 100644 --- a/ardor3d-audio/src/main/java/com/ardor3d/audio/FilenameURL.java +++ b/ardor3d-audio/src/main/java/com/ardor3d/audio/FilenameURL.java @@ -17,7 +17,7 @@ import java.net.URL; * with a URL. Handles either case where user supplies a String path or user * supplies a URL instance. *

- * SoundSystem License:

+ * SoundSystem 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 * like, provided the following conditions are met: diff --git a/ardor3d-audio/src/main/java/com/ardor3d/audio/ICodec.java b/ardor3d-audio/src/main/java/com/ardor3d/audio/ICodec.java index bddd958..648d1fc 100644 --- a/ardor3d-audio/src/main/java/com/ardor3d/audio/ICodec.java +++ b/ardor3d-audio/src/main/java/com/ardor3d/audio/ICodec.java @@ -16,7 +16,7 @@ import com.ardor3d.audio.sampled.AudioFormat; * The ICodec interface provides a common interface for SoundSystem to use * for accessing external codec libraries. *

- * SoundSystem License:

+ * SoundSystem 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 * like, provided the following conditions are met: diff --git a/ardor3d-audio/src/main/java/com/ardor3d/audio/Library.java b/ardor3d-audio/src/main/java/com/ardor3d/audio/Library.java index d11d2f7..dd64afe 100644 --- a/ardor3d-audio/src/main/java/com/ardor3d/audio/Library.java +++ b/ardor3d-audio/src/main/java/com/ardor3d/audio/Library.java @@ -27,7 +27,7 @@ import com.ardor3d.audio.sampled.AudioFormat; * no other audio libraries are supported by the host machine, or to mute all * sound. *

- * SoundSystem License:

+ * SoundSystem 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 * like, provided the following conditions are met: diff --git a/ardor3d-audio/src/main/java/com/ardor3d/audio/ListenerData.java b/ardor3d-audio/src/main/java/com/ardor3d/audio/ListenerData.java index 25c1af0..c79d06e 100644 --- a/ardor3d-audio/src/main/java/com/ardor3d/audio/ListenerData.java +++ b/ardor3d-audio/src/main/java/com/ardor3d/audio/ListenerData.java @@ -18,7 +18,7 @@ import com.ardor3d.math.Vector3; * {@link com.ardor3d.math.Vector3 Vector3} for more information about 3D * coordinates and vectors. *

- * SoundSystem License:

+ * SoundSystem 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 * like, provided the following conditions are met: diff --git a/ardor3d-audio/src/main/java/com/ardor3d/audio/SimpleThread.java b/ardor3d-audio/src/main/java/com/ardor3d/audio/SimpleThread.java index 72dbb38..55be664 100644 --- a/ardor3d-audio/src/main/java/com/ardor3d/audio/SimpleThread.java +++ b/ardor3d-audio/src/main/java/com/ardor3d/audio/SimpleThread.java @@ -17,7 +17,7 @@ package com.ardor3d.audio; * be called at the bottom of overriden cleanup() methods, and cleanup() * must be called at the bottom of the run() method for all extended classes. *

- * SoundSystem License:

+ * SoundSystem 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 * like, provided the following conditions are met: diff --git a/ardor3d-audio/src/main/java/com/ardor3d/audio/SoundBuffer.java b/ardor3d-audio/src/main/java/com/ardor3d/audio/SoundBuffer.java index 047e926..dacbf91 100644 --- a/ardor3d-audio/src/main/java/com/ardor3d/audio/SoundBuffer.java +++ b/ardor3d-audio/src/main/java/com/ardor3d/audio/SoundBuffer.java @@ -15,7 +15,7 @@ import com.ardor3d.audio.sampled.AudioFormat; * The SoundBuffer class is used to wrap audio data along with the format in * which the data is stored. *

- * SoundSystem License:

+ * SoundSystem 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 * like, provided the following conditions are met: diff --git a/ardor3d-audio/src/main/java/com/ardor3d/audio/SoundSystem.java b/ardor3d-audio/src/main/java/com/ardor3d/audio/SoundSystem.java index a30f05d..14df961 100644 --- a/ardor3d-audio/src/main/java/com/ardor3d/audio/SoundSystem.java +++ b/ardor3d-audio/src/main/java/com/ardor3d/audio/SoundSystem.java @@ -37,7 +37,7 @@ import com.ardor3d.audio.sampled.AudioFormat; * {@link com.ardor3d.audio.SoundSystemConfig SoundSystemConfig} for information * about changing default settings and linking with external pluggins. *

- * SoundSystem License:

+ * SoundSystem 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 * like, provided the following conditions are met: diff --git a/ardor3d-audio/src/main/java/com/ardor3d/audio/SoundSystemConfig.java b/ardor3d-audio/src/main/java/com/ardor3d/audio/SoundSystemConfig.java index 65bdf2a..e20e86a 100644 --- a/ardor3d-audio/src/main/java/com/ardor3d/audio/SoundSystemConfig.java +++ b/ardor3d-audio/src/main/java/com/ardor3d/audio/SoundSystemConfig.java @@ -22,7 +22,7 @@ import java.util.LinkedList; * are not sure where to find something in the SoundSystem library, this is * probably a good place to start. *

- * SoundSystem License:

+ * SoundSystem 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 * like, provided the following conditions are met: diff --git a/ardor3d-audio/src/main/java/com/ardor3d/audio/SoundSystemException.java b/ardor3d-audio/src/main/java/com/ardor3d/audio/SoundSystemException.java index 9d22c81..b19fd36 100644 --- a/ardor3d-audio/src/main/java/com/ardor3d/audio/SoundSystemException.java +++ b/ardor3d-audio/src/main/java/com/ardor3d/audio/SoundSystemException.java @@ -13,7 +13,7 @@ package com.ardor3d.audio; * The SoundSystemException class is used to provide information about serious * errors. *

- * SoundSystem License:

+ * SoundSystem 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 * like, provided the following conditions are met: diff --git a/ardor3d-audio/src/main/java/com/ardor3d/audio/SoundSystemLogger.java b/ardor3d-audio/src/main/java/com/ardor3d/audio/SoundSystemLogger.java index dbb4a90..433cacb 100644 --- a/ardor3d-audio/src/main/java/com/ardor3d/audio/SoundSystemLogger.java +++ b/ardor3d-audio/src/main/java/com/ardor3d/audio/SoundSystemLogger.java @@ -23,7 +23,7 @@ package com.ardor3d.audio; * set by the user, then an instance of this base class will be automatically * created by default when the SoundSystem class is instantiated. *

- * SoundSystem License:

+ * SoundSystem 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 * like, provided the following conditions are met: diff --git a/ardor3d-audio/src/main/java/com/ardor3d/audio/Source.java b/ardor3d-audio/src/main/java/com/ardor3d/audio/Source.java index 38af692..ddfea91 100644 --- a/ardor3d-audio/src/main/java/com/ardor3d/audio/Source.java +++ b/ardor3d-audio/src/main/java/com/ardor3d/audio/Source.java @@ -23,7 +23,7 @@ import com.ardor3d.audio.sampled.AudioFormat; * This class is also used by the "No Sound" library to represent a mute * source. *

- * SoundSystem License:

+ * SoundSystem 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 * like, provided the following conditions are met: diff --git a/ardor3d-audio/src/main/java/com/ardor3d/audio/StreamThread.java b/ardor3d-audio/src/main/java/com/ardor3d/audio/StreamThread.java index 77b411a..edf0d6c 100644 --- a/ardor3d-audio/src/main/java/com/ardor3d/audio/StreamThread.java +++ b/ardor3d-audio/src/main/java/com/ardor3d/audio/StreamThread.java @@ -19,7 +19,7 @@ import java.util.ListIterator; * finished playing, so it is necessary to call interrupt() after adding new * streaming sources to the list. *

- * SoundSystem License:

+ * SoundSystem 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 * like, provided the following conditions are met: diff --git a/ardor3d-audio/src/main/java/com/ardor3d/audio/codecs/CodecJOrbis.java b/ardor3d-audio/src/main/java/com/ardor3d/audio/codecs/CodecJOrbis.java index 5bfde5d..30e0a32 100644 --- a/ardor3d-audio/src/main/java/com/ardor3d/audio/codecs/CodecJOrbis.java +++ b/ardor3d-audio/src/main/java/com/ardor3d/audio/codecs/CodecJOrbis.java @@ -34,7 +34,7 @@ import com.ardor3d.audio.SoundSystemLogger; /** * The CodecJOrbis class provides an ICodec interface to the external JOrbis * library. - * SoundSystem CodecJOrbis Class License:

+ * SoundSystem CodecJOrbis Class License:

* You are free to use this class for any purpose, commercial or otherwise. * You may modify this class or source code, and distribute it any way you * like, provided the following conditions are met: diff --git a/ardor3d-audio/src/main/java/com/ardor3d/audio/sampled/AudioFormat.java b/ardor3d-audio/src/main/java/com/ardor3d/audio/sampled/AudioFormat.java index a2959ea..7d2661f 100644 --- a/ardor3d-audio/src/main/java/com/ardor3d/audio/sampled/AudioFormat.java +++ b/ardor3d-audio/src/main/java/com/ardor3d/audio/sampled/AudioFormat.java @@ -50,9 +50,9 @@ import java.util.Objects; * the audio format specifies the kind of the data that can be read from the * line. *

- * Sound files also have audio formats, of course. The {@link AudioFileFormat} + * Sound files also have audio formats, of course. The {@link javax.sound.sampled.AudioFileFormat} * class encapsulates an {@code AudioFormat} in addition to other, file-specific - * information. Similarly, an {@link AudioInputStream} has an + * information. Similarly, an {@link javax.sound.sampled.AudioInputStream} has an * {@code AudioFormat}. *

* The {@code AudioFormat} class accommodates a number of common sound-file @@ -92,7 +92,7 @@ import java.util.Objects; * format to and from the service providers. Therefore, properties are ignored * in the {@link #matches(AudioFormat)} method. However, methods which rely on * the installed service providers, like - * {@link AudioSystem#isConversionSupported (AudioFormat, AudioFormat) + * {@link javax.sound.sampled.AudioSystem#isConversionSupported (AudioFormat, AudioFormat) * isConversionSupported} may consider properties, depending on the respective * service provider implementation. *

@@ -129,9 +129,9 @@ import java.util.Objects; * * @author Kara Kytle * @author Florian Bomers - * @see DataLine#getFormat - * @see AudioInputStream#getFormat - * @see AudioFileFormat + * @see javax.sound.sampled.DataLine#getFormat + * @see javax.sound.sampled.AudioInputStream#getFormat + * @see javax.sound.sampled.AudioFileFormat * @see javax.sound.sampled.spi.FormatConversionProvider * @since 1.3 */ @@ -288,9 +288,9 @@ public class AudioFormat { * Obtains the sample rate. For compressed formats, the return value is the * sample rate of the uncompressed audio data. When this {@code AudioFormat} * is used for queries (e.g. - * {@link AudioSystem#isConversionSupported(AudioFormat, AudioFormat) + * {@link javax.sound.sampled.AudioSystem#isConversionSupported(javax.sound.sampled.AudioFormat, javax.sound.sampled.AudioFormat) * AudioSystem.isConversionSupported}) or capabilities (e.g. - * {@link DataLine.Info#getFormats DataLine.Info.getFormats}), a sample rate + * {@link javax.sound.sampled.DataLine.Info#getFormats DataLine.Info.getFormats}), a sample rate * of {@code AudioSystem.NOT_SPECIFIED} means that any sample rate is * acceptable. {@code AudioSystem.NOT_SPECIFIED} is also returned when the * sample rate is not defined for this audio format. @@ -298,7 +298,7 @@ public class AudioFormat { * @return the number of samples per second, or * {@code AudioSystem.NOT_SPECIFIED} * @see #getFrameRate() - * @see AudioSystem#NOT_SPECIFIED + * @see javax.sound.sampled.AudioSystem#NOT_SPECIFIED */ public float getSampleRate() { return sampleRate; @@ -308,9 +308,9 @@ public class AudioFormat { * Obtains the size of a sample. For compressed formats, the return value is * the sample size of the uncompressed audio data. When this * {@code AudioFormat} is used for queries (e.g. - * {@link AudioSystem#isConversionSupported(AudioFormat,AudioFormat) + * {@link javax.sound.sampled.AudioSystem#isConversionSupported(javax.sound.sampled.AudioFormat,javax.sound.sampled.AudioFormat) * AudioSystem.isConversionSupported}) or capabilities (e.g. - * {@link DataLine.Info#getFormats DataLine.Info.getFormats}), a sample size + * {@link javax.sound.sampled.DataLine.Info#getFormats DataLine.Info.getFormats}), a sample size * of {@code AudioSystem.NOT_SPECIFIED} means that any sample size is * acceptable. {@code AudioSystem.NOT_SPECIFIED} is also returned when the * sample size is not defined for this audio format. @@ -318,7 +318,7 @@ public class AudioFormat { * @return the number of bits in each sample, or * {@code AudioSystem.NOT_SPECIFIED} * @see #getFrameSize() - * @see AudioSystem#NOT_SPECIFIED + * @see javax.sound.sampled.AudioSystem#NOT_SPECIFIED */ public int getSampleSizeInBits() { return sampleSizeInBits; @@ -326,15 +326,15 @@ public class AudioFormat { /** * Obtains the number of channels. When this {@code AudioFormat} is used for - * queries (e.g. {@link AudioSystem#isConversionSupported(AudioFormat, - * AudioFormat) AudioSystem.isConversionSupported}) or capabilities (e.g. - * {@link DataLine.Info#getFormats DataLine.Info.getFormats}), a return + * queries (e.g. {@link javax.sound.sampled.AudioSystem#isConversionSupported(javax.sound.sampled.AudioFormat, + * javax.sound.sampled.AudioFormat) javax.sound.sampled.AudioSystem.isConversionSupported}) or capabilities (e.g. + * {@link javax.sound.sampled.DataLine.Info#getFormats DataLine.Info.getFormats}), a return * value of {@code AudioSystem.NOT_SPECIFIED} means that any (positive) * number of channels is acceptable. * * @return The number of channels (1 for mono, 2 for stereo, etc.), or * {@code AudioSystem.NOT_SPECIFIED} - * @see AudioSystem#NOT_SPECIFIED + * @see javax.sound.sampled.AudioSystem#NOT_SPECIFIED */ public int getChannels() { return channels; @@ -342,9 +342,9 @@ public class AudioFormat { /** * Obtains the frame size in bytes. When this {@code AudioFormat} is used - * for queries (e.g. {@link AudioSystem#isConversionSupported(AudioFormat, - * AudioFormat) AudioSystem.isConversionSupported}) or capabilities (e.g. - * {@link DataLine.Info#getFormats DataLine.Info.getFormats}), a frame size + * for queries (e.g. {@link javax.sound.sampled.AudioSystem#isConversionSupported(javax.sound.sampled.AudioFormat, + * javax.sound.sampled.AudioFormat) javax.sound.sampled.AudioSystem.isConversionSupported}) or capabilities (e.g. + * {@link javax.sound.sampled.DataLine.Info#getFormats DataLine.Info.getFormats}), a frame size * of {@code AudioSystem.NOT_SPECIFIED} means that any frame size is * acceptable. {@code AudioSystem.NOT_SPECIFIED} is also returned when the * frame size is not defined for this audio format. @@ -352,7 +352,7 @@ public class AudioFormat { * @return the number of bytes per frame, or * {@code AudioSystem.NOT_SPECIFIED} * @see #getSampleSizeInBits() - * @see AudioSystem#NOT_SPECIFIED + * @see javax.sound.sampled.AudioSystem#NOT_SPECIFIED */ public int getFrameSize() { return frameSize; @@ -361,9 +361,9 @@ public class AudioFormat { /** * Obtains the frame rate in frames per second. When this * {@code AudioFormat} is used for queries (e.g. - * {@link AudioSystem#isConversionSupported(AudioFormat,AudioFormat) + * {@link javax.sound.sampled.AudioSystem#isConversionSupported(javax.sound.sampled.AudioFormat,javax.sound.sampled.AudioFormat) * AudioSystem.isConversionSupported}) or capabilities (e.g. - * {@link DataLine.Info#getFormats DataLine.Info.getFormats}), a frame rate + * {@link javax.sound.sampled.DataLine.Info#getFormats DataLine.Info.getFormats}), a frame rate * of {@code AudioSystem.NOT_SPECIFIED} means that any frame rate is * acceptable. {@code AudioSystem.NOT_SPECIFIED} is also returned when the * frame rate is not defined for this audio format. @@ -371,7 +371,7 @@ public class AudioFormat { * @return the number of frames per second, or * {@code AudioSystem.NOT_SPECIFIED} * @see #getSampleRate() - * @see AudioSystem#NOT_SPECIFIED + * @see javax.sound.sampled.AudioSystem#NOT_SPECIFIED */ public float getFrameRate() { return frameRate; @@ -391,7 +391,7 @@ public class AudioFormat { /** * Obtain an unmodifiable map of properties. The concept of properties is - * further explained in the {@link AudioFileFormat class description}. + * further explained in the {@link javax.sound.sampled.AudioFileFormat class description}. * * @return a {@code Map} object containing all properties. * If no properties are recognized, an empty map is returned. @@ -411,7 +411,7 @@ public class AudioFormat { /** * Obtain the property value specified by the key. The concept of properties - * is further explained in the {@link AudioFileFormat class description}. + * is further explained in the {@link javax.sound.sampled.AudioFileFormat class description}. *

* If the specified property is not defined for a particular file format, * this method returns {@code null}. @@ -523,7 +523,7 @@ public class AudioFormat { * objects created by this class, such as {@code PCM_SIGNED} or * {@code PCM_UNSIGNED}. Service providers can create new encodings, such as * compressed audio formats, and make these available through the - * {@link AudioSystem} class. + * {@link javax.sound.sampled.AudioSystem} class. *

* The {@code Encoding} class is static, so that all {@code AudioFormat} * objects that have the same encoding will refer to the same object (rather @@ -531,7 +531,7 @@ public class AudioFormat { * made by checking that two format's encodings are equal. * * @author Kara Kytle - * @see AudioFormat + * @see javax.sound.sampled.AudioFormat * @see javax.sound.sampled.spi.FormatConversionProvider * @since 1.3 */ -- cgit v1.2.3