Improve javadoc of JukeBox volume setter/getter

Signed-off-by: Matthias <webmaster@pottgames.de>
Hangman · Jul 31, 2024 · 8fbe29d · 8fbe29d
1 parent 02393e5
commit 8fbe29d
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/core/src/main/java/de/pottgames/tuningfork/jukebox/JukeBox.java b/core/src/main/java/de/pottgames/tuningfork/jukebox/JukeBox.java
@@ -160,7 +160,7 @@ protected float fadeOut(SongSource source, SongSettings settings, float playback
      * master volume = JukeBox.getVolume() * SongSettings.fadeVolume()
      * </code>
      *
-     * @param volume
+     * @param volume in the range of 0.0 - 1.0 with 0 being silent and 1 being the maximum volume, values outside of the range will be clamped
      */
     public void setVolume(float volume) {
         this.volume = MathUtils.clamp(volume, 0f, 1f);
@@ -174,7 +174,7 @@ public void setVolume(float volume) {
      * master volume = JukeBox.getVolume() * SongSettings.fadeVolume()
      * </code>
      *
-     * @return the master volume
+     * @return the master volume in the range of 0.0 - 1.0 with 0 being silent and 1 being the maximum volume
      */
     public float getVolume() {
         return this.volume;