jme3-desktop/jme3-effects JavaDoc corrections (comments only)

jme3-desktop/src/main/java/com/jme3/app/state/AWTComponentAppState.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -116,8 +116,8 @@ public class AWTComponentAppState extends AbstractAppState {
   }
   
   /**
-   * Get the {@link AWTFrameProcessor.TransferMode transfer mode} that is used by the underlying frame processor.
-   * @return the {@link AWTFrameProcessor.TransferMode transfer mode} that is used by the underlying frame processor.
+   * Get the {@link com.jme3.system.AWTFrameProcessor.TransferMode transfer mode} that is used by the underlying frame processor.
+   * @return the {@link com.jme3.system.AWTFrameProcessor.TransferMode transfer mode} that is used by the underlying frame processor.
    * @see #setTransferMode(com.jme3.system.AWTFrameProcessor.TransferMode)
    */
   public AWTFrameProcessor.TransferMode getTransferMode(){
@@ -125,8 +125,8 @@ public class AWTComponentAppState extends AbstractAppState {
   }
   
   /**
-   * Set the {@link AWTFrameProcessor.TransferMode transfer mode} that is used by the underlying frame processor.
-   * @param mode the {@link AWTFrameProcessor.TransferMode transfer mode} that is used by the underlying frame processor.
+   * Set the {@link com.jme3.system.AWTFrameProcessor.TransferMode transfer mode} that is used by the underlying frame processor.
+   * @param mode the {@link com.jme3.system.AWTFrameProcessor.TransferMode transfer mode} that is used by the underlying frame processor.
    * @see #getTransferMode()
    */
   public void setTransferMode(AWTFrameProcessor.TransferMode mode) {

jme3-desktop/src/main/java/com/jme3/app/state/VideoRecorderAppState.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -120,7 +120,6 @@ public class VideoRecorderAppState extends AbstractAppState {
      * This constructor allows you to specify the output file of the video as well as the quality
      * @param file the video file
      * @param quality the quality of the jpegs in the video stream (0.0 smallest file - 1.0 largest file)
-     * @param framerate the frame rate of the resulting video, the application will be locked to this framerate
      */
     public VideoRecorderAppState(File file, float quality) {
         this.file = file;

jme3-desktop/src/main/java/com/jme3/system/AWTFrameProcessor.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -420,7 +420,6 @@ public class AWTFrameProcessor implements SceneProcessor, PropertyChangeListener
 	 *
 	 * @param destination the destination.
 	 * @param application the application.
-	 * @param inputNode   the input node.
 	 * @param viewPort    the view port.
 	 * @param main        true if this processor is main.
 	 */
@@ -477,7 +476,6 @@ public class AWTFrameProcessor implements SceneProcessor, PropertyChangeListener
 	 *
 	 * @param application the application.
 	 * @param destination the destination.
-	 * @param inputNode   the input node.
 	 */
 	protected void bindDestination(Application application, Component destination) {
 

jme3-desktop/src/main/java/jme3tools/navigation/NavCalculator.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -139,7 +139,7 @@ public class NavCalculator {
      * Calculate a plane sailing situation - i.e. where Lats are the same 
      * @param p1
      * @param p2
-     * @return
+     * @return a new instance
      * @since 1.0
      */
     public RLSailing planeSailing(Position p1, Position p2) {
@@ -171,7 +171,7 @@ public class NavCalculator {
      * @param tc
      * @param p1 position one
      * @param p2 position two
-     * @return
+     * @return angle (in degrees)
      * @since 1.0
      */
     public static double convertCourse(float tc, Position p1, Position p2) {
@@ -312,9 +312,8 @@ public class NavCalculator {
      * Computes the coordinate of position B relative to an offset given
      * a distance and an angle.
      *
-     * @param offset        The offset position.
-     * @param bearing       The bearing between the offset and the coordinate
-     *                      that you want to calculate.
+     * @param initialPos
+     * @param heading
      * @param distance      The distance, in meters, between the offset
      *                      and point B.
      * @return              The position of point B that is located from
@@ -554,7 +553,7 @@ public class NavCalculator {
      * 
      * @param p1
      * @param p2
-     * @return
+     * @return bearing (in degrees)
      * @since 1.0
      */
     public static int computeBearing(Position p1, Position p2) {
@@ -572,7 +571,7 @@ public class NavCalculator {
      *
      * @param p1
      * @param p2
-     * @return
+     * @return angle (in degrees)
      */
     public static int computeAngle(Position p1, Position p2) {
         // cos (adj / hyp)

jme3-effects/src/main/java/com/jme3/post/filters/BloomFilter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -52,7 +52,7 @@ import java.util.ArrayList;
  * There are 2 mode : Scene and Objects.<br>
  * Scene mode extracts the bright parts of the scene to make them glow<br>
  * Object mode make objects glow according to their material's glowMap or their GlowColor<br>
- * @see <a href="http://jmonkeyengine.github.io/wiki/jme3/advanced/bloom_and_glow.html">advanced:bloom_and_glow</a> for more details
+ * See <a href="http://jmonkeyengine.github.io/wiki/jme3/advanced/bloom_and_glow.html">advanced:bloom_and_glow</a> for more details
  * 
  * @author Rémy Bouquet aka Nehon
  */
@@ -226,7 +226,7 @@ public class BloomFilter extends Filter {
 
     /**
      * returns the bloom intensity
-     * @return 
+     * @return the intensity value
      */
     public float getBloomIntensity() {
         return bloomIntensity;
@@ -242,7 +242,7 @@ public class BloomFilter extends Filter {
 
     /**
      * returns the blur scale
-     * @return 
+     * @return the blur scale
      */
     public float getBlurScale() {
         return blurScale;
@@ -259,7 +259,7 @@ public class BloomFilter extends Filter {
     /**
      * returns the exposure cutoff<br>
      * for more details see {@link #setExposureCutOff(float exposureCutOff)}
-     * @return 
+     * @return the exposure cutoff
      */    
     public float getExposureCutOff() {
         return exposureCutOff;
@@ -275,8 +275,8 @@ public class BloomFilter extends Filter {
 
     /**
      * returns the exposure power<br>
-     * form more details see {@link #setExposurePower(float exposurePower)}
-     * @return 
+     * for more details see {@link #setExposurePower(float exposurePower)}
+     * @return the exposure power
      */
     public float getExposurePower() {
         return exposurePower;
@@ -293,8 +293,8 @@ public class BloomFilter extends Filter {
 
     /**
      * returns the downSampling factor<br>
-     * form more details see {@link #setDownSamplingFactor(float downSamplingFactor)}
-     * @return
+     * for more details see {@link #setDownSamplingFactor(float downSamplingFactor)}
+     * @return the downsampling factor
      */
     public float getDownSamplingFactor() {
         return downSamplingFactor;

jme3-effects/src/main/java/com/jme3/post/filters/CartoonEdgeFilter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -115,7 +115,7 @@ public class CartoonEdgeFilter extends Filter {
     /**
      * Return the depth sensitivity<br>
      * for more details see {@link #setDepthSensitivity(float depthSensitivity)}
-     * @return 
+     * @return the depth sensitivity
      */
     public float getDepthSensitivity() {
         return depthSensitivity;
@@ -136,7 +136,7 @@ public class CartoonEdgeFilter extends Filter {
     /**
      * returns the depth threshold<br>
      * for more details see {@link #setDepthThreshold(float depthThreshold)}
-     * @return 
+     * @return the threshold
      */
     public float getDepthThreshold() {
         return depthThreshold;
@@ -157,7 +157,7 @@ public class CartoonEdgeFilter extends Filter {
     /**
      * returns the edge intensity<br>
      * for more details see {@link #setEdgeIntensity(float edgeIntensity) }
-     * @return 
+     * @return the intensity
      */
     public float getEdgeIntensity() {
         return edgeIntensity;
@@ -177,7 +177,7 @@ public class CartoonEdgeFilter extends Filter {
 
     /**
      * returns the width of the edges
-     * @return 
+     * @return the width
      */
     public float getEdgeWidth() {
         return edgeWidth;
@@ -198,7 +198,7 @@ public class CartoonEdgeFilter extends Filter {
     /**
      * returns the normals sensitivity<br>
      * form more details see {@link #setNormalSensitivity(float normalSensitivity)}
-     * @return 
+     * @return the sensitivity
      */
     public float getNormalSensitivity() {
         return normalSensitivity;
@@ -219,7 +219,7 @@ public class CartoonEdgeFilter extends Filter {
      * returns the normal threshold<br>
      * for more details see {@link #setNormalThreshold(float normalThreshold)}
      * 
-     * @return 
+     * @return the threshold
      */
     public float getNormalThreshold() {
         return normalThreshold;
@@ -238,7 +238,7 @@ public class CartoonEdgeFilter extends Filter {
 
     /**
      * returns the edge color
-     * @return
+     * @return the pre-existing instance
      */
     public ColorRGBA getEdgeColor() {
         return edgeColor;

jme3-effects/src/main/java/com/jme3/post/filters/ComposeFilter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -68,7 +68,7 @@ public class ComposeFilter extends Filter {
     /**
      * creates a ComposeFilter with the given texture
      *
-     * @param color
+     * @param compositeTexture
      */
     public ComposeFilter(Texture2D compositeTexture) {
         this();

jme3-effects/src/main/java/com/jme3/post/filters/CrossHatchFilter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -219,7 +219,7 @@ public class CrossHatchFilter extends Filter {
 
     /**
      * Returns line color
-     * @return 
+     * @return the pre-existing instance
      */
     public ColorRGBA getLineColor() {
         return lineColor;
@@ -227,7 +227,7 @@ public class CrossHatchFilter extends Filter {
 
     /**
      * Returns paper background color
-     * @return 
+     * @return the pre-existing instance
      */
     public ColorRGBA getPaperColor() {
         return paperColor;

jme3-effects/src/main/java/com/jme3/post/filters/DepthOfFieldFilter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -110,7 +110,7 @@ public class DepthOfFieldFilter extends Filter {
 
     /**
      * returns the focus distance
-     * @return 
+     * @return the distance
      */
     public float getFocusDistance() {
         return focusDistance;
@@ -131,7 +131,7 @@ public class DepthOfFieldFilter extends Filter {
 
     /**
      * returns the focus range
-     * @return 
+     * @return the distance
      */
     public float getFocusRange() {
         return focusRange;
@@ -159,7 +159,7 @@ public class DepthOfFieldFilter extends Filter {
 
     /**
      * returns the blur scale
-     * @return 
+     * @return the scale
      */
     public float getBlurScale() {
         return blurScale;
@@ -188,7 +188,7 @@ public class DepthOfFieldFilter extends Filter {
 
     /**
      * returns the blur threshold.
-     * @return 
+     * @return the threshold
      */
     public float getBlurThreshold() {
         return blurThreshold;

jme3-effects/src/main/java/com/jme3/post/filters/FadeFilter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -101,7 +101,7 @@ public class FadeFilter extends Filter {
 
     /**
      * returns the duration of the effect 
-     * @return 
+     * @return the duration (in seconds)
      */
     public float getDuration() {
         return duration;
@@ -155,7 +155,7 @@ public class FadeFilter extends Filter {
     /**
      * return the current value of the fading
      * can be used to check if fade is complete (eg value=1)
-     * @return 
+     * @return the fractional progress (≥0, ≤1)
      */
     public float getValue() {
         return value;

jme3-effects/src/main/java/com/jme3/post/filters/FogFilter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -95,7 +95,7 @@ public class FogFilter extends Filter {
 
     /**
      * returns the fog color
-     * @return
+     * @return the pre-existing instance
      */
     public ColorRGBA getFogColor() {
         return fogColor;
@@ -114,7 +114,7 @@ public class FogFilter extends Filter {
 
     /**
      * returns the fog density
-     * @return
+     * @return the density value
      */
     public float getFogDensity() {
         return fogDensity;
@@ -133,7 +133,7 @@ public class FogFilter extends Filter {
 
     /**
      * returns the fog distance
-     * @return
+     * @return the distance
      */
     public float getFogDistance() {
         return fogDistance;

jme3-effects/src/main/java/com/jme3/post/filters/LightScatteringFilter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -133,7 +133,7 @@ public class LightScatteringFilter extends Filter {
     /**
      * returns the blur start of the scattering 
      * see {@link #setBlurStart(float blurStart)}
-     * @return 
+     * @return the start distance
      */
     public float getBlurStart() {
         return blurStart;
@@ -151,7 +151,7 @@ public class LightScatteringFilter extends Filter {
     /**
      * returns the blur width<br>
      * see {@link #setBlurWidth(float blurWidth)}
-     * @return 
+     * @return the width
      */
     public float getBlurWidth() {
         return blurWidth;
@@ -169,7 +169,7 @@ public class LightScatteringFilter extends Filter {
      * returns the light density
      * see {@link #setLightDensity(float lightDensity)}
      * 
-     * @return 
+     * @return the density
      */
     public float getLightDensity() {
         return lightDensity;
@@ -185,7 +185,7 @@ public class LightScatteringFilter extends Filter {
 
     /**
      * returns the light position
-     * @return 
+     * @return the pre-existing vector
      */
     public Vector3f getLightPosition() {
         return lightPosition;
@@ -201,7 +201,7 @@ public class LightScatteringFilter extends Filter {
 
     /**
      * returns the number of samples for the radial blur
-     * @return 
+     * @return count (&ge;0)
      */
     public int getNbSamples() {
         return nbSamples;

jme3-effects/src/main/java/com/jme3/post/filters/RadialBlurFilter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -81,7 +81,7 @@ public class RadialBlurFilter extends Filter {
 
     /**
      * return the sample distance
-     * @return 
+     * @return the distance
      */
     public float getSampleDistance() {
         return sampleDist;
@@ -97,7 +97,7 @@ public class RadialBlurFilter extends Filter {
 
     /**
      * 
-     * @return 
+     * @return the distance
      * @deprecated use {@link #getSampleDistance()}
      */
     @Deprecated
@@ -117,7 +117,7 @@ public class RadialBlurFilter extends Filter {
 
     /**
      * Returns the sample Strength
-     * @return 
+     * @return the strength value
      */
     public float getSampleStrength() {
         return sampleStrength;

jme3-effects/src/main/java/com/jme3/post/filters/TranslucentBucketFilter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -107,8 +107,8 @@ public final class TranslucentBucketFilter extends Filter {
     }
 
     /**
-     * Override this method and return false if your Filter does not need the scene texture
-     * @return
+     * Override this method and return true if your Filter needs the scene texture
+     * @return false
      */
     @Override
     protected boolean isRequiresSceneTexture() {

jme3-effects/src/main/java/com/jme3/water/ReflectionProcessor.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -110,7 +110,7 @@ public class ReflectionProcessor implements SceneProcessor {
     /**
      * Internal use only<br>
      * returns the frame buffer
-     * @return 
+     * @return the pre-existing buffer
      */
     public FrameBuffer getReflectionBuffer() {
         return reflectionBuffer;
@@ -127,7 +127,7 @@ public class ReflectionProcessor implements SceneProcessor {
 
     /**
      * returns the reflection cam
-     * @return 
+     * @return the pre-existing Camera
      */
     public Camera getReflectionCam() {
         return reflectionCam;
@@ -143,7 +143,7 @@ public class ReflectionProcessor implements SceneProcessor {
 
     /**
      * returns the reflection clip plane
-     * @return 
+     * @return the pre-existing instance
      */
     public Plane getReflectionClipPlane() {
         return reflectionClipPlane;

jme3-effects/src/main/java/com/jme3/water/SimpleWaterProcessor.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -310,7 +310,7 @@ public class SimpleWaterProcessor implements SceneProcessor {
 
     /**
      * Get the water material from this processor, apply this to your water quad.
-     * @return
+     * @return the pre-existing Material
      */
     public Material getMaterial() {
         return material;
@@ -327,7 +327,7 @@ public class SimpleWaterProcessor implements SceneProcessor {
 
     /**
      * returns the width of the reflection and refraction textures
-     * @return
+     * @return the width (in pixels)
      */
     public int getRenderWidth() {
         return renderWidth;
@@ -335,7 +335,7 @@ public class SimpleWaterProcessor implements SceneProcessor {
 
     /**
      * returns the height of the reflection and refraction textures
-     * @return
+     * @return the height (in pixels)
      */
     public int getRenderHeight() {
         return renderHeight;
@@ -354,7 +354,7 @@ public class SimpleWaterProcessor implements SceneProcessor {
 
     /**
      * returns the water plane
-     * @return
+     * @return the pre-existing instance
      */
     public Plane getPlane() {
         return plane;
@@ -417,7 +417,7 @@ public class SimpleWaterProcessor implements SceneProcessor {
 
     /**
      * return the water depth
-     * @return
+     * @return the depth
      */
     public float getWaterDepth() {
         return waterDepth;
@@ -425,7 +425,7 @@ public class SimpleWaterProcessor implements SceneProcessor {
 
     /**
      * returns water transparency
-     * @return
+     * @return the transparency value
      */
     public float getWaterTransparency() {
         return waterTransparency;
@@ -515,7 +515,7 @@ public class SimpleWaterProcessor implements SceneProcessor {
 
     /**
      * returns true if the waterprocessor is in debug mode
-     * @return
+     * @return true if in debug mode, otherwise false
      */
     public boolean isDebug() {
         return debug;
@@ -533,7 +533,7 @@ public class SimpleWaterProcessor implements SceneProcessor {
      * Creates a quad with the water material applied to it.
      * @param width
      * @param height
-     * @return
+     * @return a new Geometry
      */
     public Geometry createWaterGeometry(float width, float height) {
         Quad quad = new Quad(width, height);
@@ -545,7 +545,7 @@ public class SimpleWaterProcessor implements SceneProcessor {
 
     /**
      * returns the reflection clipping plane offset
-     * @return
+     * @return the offset value
      */
     public float getReflectionClippingOffset() {
         return reflectionClippingOffset;
@@ -563,7 +563,7 @@ public class SimpleWaterProcessor implements SceneProcessor {
 
     /**
      * returns the refraction clipping plane offset
-     * @return
+     * @return the offset value
      */
     public float getRefractionClippingOffset() {
         return refractionClippingOffset;

jme3-effects/src/main/java/com/jme3/water/WaterFilter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -464,7 +464,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
 
     /**
      * gets the height of the water plane
-     * @return
+     * @return the height
      */
     public float getWaterHeight() {
         return waterHeight;
@@ -517,7 +517,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
 
     /**
      * returns the waterTransparency value
-     * @return
+     * @return the transparency value
      */
     public float getWaterTransparency() {
         return waterTransparency;
@@ -539,7 +539,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
 
     /**
      * Returns the normal scales applied to the normal map
-     * @return
+     * @return the scale factor
      */
     public float getNormalScale() {
         return normalScale;
@@ -559,8 +559,8 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
     }
 
     /**
-     * returns the refractoin constant
-     * @return 
+     * returns the refraction constant
+     * @return the refraction constant
      */
     public float getRefractionConstant() {
         return refractionConstant;
@@ -584,7 +584,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
 
     /**
      * return the maximum wave amplitude
-     * @return 
+     * @return the maximum amplitude
      */
     public float getMaxAmplitude() {
         return maxAmplitude;
@@ -604,7 +604,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
 
     /**
      * gets the light direction
-     * @return
+     * @return the pre-existing vector
      */
     public Vector3f getLightDirection() {
         return lightDirection;
@@ -623,7 +623,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
 
     /**
      * returns the light color
-     * @return
+     * @return the pre-existing instance
      */
     public ColorRGBA getLightColor() {
         return lightColor;
@@ -643,7 +643,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
 
     /**
      * Return the shoreHardeness
-     * @return
+     * @return the hardness value
      */
     public float getShoreHardness() {
         return shoreHardness;
@@ -664,7 +664,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
 
     /**
      * returns the foam hardness
-     * @return
+     * @return the hardness value
      */
     public float getFoamHardness() {
         return foamHardness;
@@ -684,7 +684,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
 
     /**
      * returns the refractionStrength
-     * @return
+     * @return the strength value
      */
     public float getRefractionStrength() {
         return refractionStrength;
@@ -705,7 +705,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
 
     /**
      * returns the scale factor of the waves height map
-     * @return
+     * @return the scale factor
      */
     public float getWaveScale() {
         return waveScale;
@@ -726,7 +726,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
 
     /**
      * returns the foam existence vector
-     * @return
+     * @return the pre-existing vector
      */
     public Vector3f getFoamExistence() {
         return foamExistence;
@@ -748,7 +748,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
 
     /**
      * gets the scale of the sun
-     * @return
+     * @return the scale factor
      */
     public float getSunScale() {
         return sunScale;
@@ -767,7 +767,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
 
     /**
      * Returns the color extinction vector of the water
-     * @return
+     * @return the pre-existing vector
      */
     public Vector3f getColorExtinction() {
         return colorExtinction;
@@ -857,7 +857,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
 
     /**
      * return the shininess factor of the water
-     * @return
+     * @return the shininess factor
      */
     public float getShininess() {
         return shininess;
@@ -877,7 +877,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
 
     /**
      * returns the speed of the waves
-     * @return
+     * @return the speed value
      */
     public float getSpeed() {
         return speed;
@@ -894,7 +894,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
     /**
      * returns the color of the water
      *
-     * @return
+     * @return the pre-existing instance
      */
     public ColorRGBA getWaterColor() {
         return waterColor;
@@ -915,7 +915,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
 
     /**
      * returns the deep water color
-     * @return
+     * @return the pre-existing instance
      */
     public ColorRGBA getDeepWaterColor() {
         return deepWaterColor;
@@ -936,7 +936,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
 
     /**
      * returns the wind direction
-     * @return
+     * @return the pre-existing direction vector
      */
     public Vector2f getWindDirection() {
         return windDirection;
@@ -957,7 +957,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
 
     /**
      * returns the size of the reflection map
-     * @return
+     * @return the size (in pixels)
      */
     public int getReflectionMapSize() {
         return reflectionMapSize;
@@ -1119,7 +1119,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
 
     /**
      * returns the foam intensity
-     * @return 
+     * @return the intensity value
      */
     public float getFoamIntensity() {
         return foamIntensity;
@@ -1140,7 +1140,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
     /**
      * returns the reflection displace
      * see {@link #setReflectionDisplace(float) }
-     * @return 
+     * @return the displacement value
      */
     public float getReflectionDisplace() {
         return reflectionDisplace;
@@ -1167,7 +1167,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
 
     /**
      * returns the distance of the fog when under water
-     * @return 
+     * @return the distance
      */
     public float getUnderWaterFogDistance() {
         return underWaterFogDistance;
@@ -1187,7 +1187,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
 
     /**
      * get the intensity of caustics under water
-     * @return 
+     * @return the intensity value (≥0, ≤1)
      */
     public float getCausticsIntensity() {
         return causticsIntensity;