From cde108c2c06a8b8bfb56dc3469cb21a82a51bc8a Mon Sep 17 00:00:00 2001 From: Lou Hamersly Date: Wed, 5 Jun 2019 00:33:02 -0400 Subject: [PATCH] #1107-Fix Javadoc warnings in OpenJDK 9+ --- jme3-android/src/main/java/com/jme3/app/AndroidHarness.java | 2 +- .../src/main/java/com/jme3/app/AndroidHarnessFragment.java | 4 ++-- .../src/main/java/com/jme3/app/DefaultAndroidProfiler.java | 2 +- .../src/main/java/com/jme3/input/android/AndroidJoyInput.java | 3 ++- .../blender/constraints/definitions/ConstraintDefinition.java | 2 +- .../jme3/scene/plugins/blender/textures/TextureHelper.java | 2 +- .../com/jme3/scene/plugins/blender/textures/TexturePixel.java | 4 ++-- .../src/main/java/com/jme3/post/filters/CrossHatchFilter.java | 2 +- .../src/main/java/com/jme3/water/SimpleWaterProcessor.java | 2 +- .../src/main/java/com/jme3/network/base/MessageProtocol.java | 2 +- .../main/java/com/jme3/terrain/noise/fractal/FractalSum.java | 2 +- 11 files changed, 14 insertions(+), 13 deletions(-) diff --git a/jme3-android/src/main/java/com/jme3/app/AndroidHarness.java b/jme3-android/src/main/java/com/jme3/app/AndroidHarness.java index 5ca059e9a..b6d0913d1 100644 --- a/jme3-android/src/main/java/com/jme3/app/AndroidHarness.java +++ b/jme3-android/src/main/java/com/jme3/app/AndroidHarness.java @@ -88,7 +88,7 @@ public class AndroidHarness extends Activity implements TouchListener, DialogInt protected int eglStencilBits = 0; /** - * Set the desired frame rate. If frameRate > 0, the application + * Set the desired frame rate. If frameRate higher than 0, the application * will be capped at the desired frame rate. * (default = -1, no frame rate cap) */ diff --git a/jme3-android/src/main/java/com/jme3/app/AndroidHarnessFragment.java b/jme3-android/src/main/java/com/jme3/app/AndroidHarnessFragment.java index 7b2bf180f..ed8976955 100644 --- a/jme3-android/src/main/java/com/jme3/app/AndroidHarnessFragment.java +++ b/jme3-android/src/main/java/com/jme3/app/AndroidHarnessFragment.java @@ -116,7 +116,7 @@ public class AndroidHarnessFragment extends Fragment implements protected int eglStencilBits = 0; /** - * Set the desired frame rate. If frameRate > 0, the application + * Set the desired frame rate. If frameRate higher than 0, the application * will be capped at the desired frame rate. * (default = -1, no frame rate cap) */ @@ -129,7 +129,7 @@ public class AndroidHarnessFragment extends Fragment implements * will have the resolution set to a maximum of maxResolutionDimension. * The other direction will be set to a value that maintains the aspect * ratio of the surfaceview.
- * Any value < 0 (default = -1) will result in the surfaceview having the + * Any value less than 0 (default = -1) will result in the surfaceview having the * same resolution as the view layout (ie. no max resolution). */ protected int maxResolutionDimension = -1; diff --git a/jme3-android/src/main/java/com/jme3/app/DefaultAndroidProfiler.java b/jme3-android/src/main/java/com/jme3/app/DefaultAndroidProfiler.java index 1308b08dd..4faa8aa89 100644 --- a/jme3-android/src/main/java/com/jme3/app/DefaultAndroidProfiler.java +++ b/jme3-android/src/main/java/com/jme3/app/DefaultAndroidProfiler.java @@ -63,7 +63,7 @@ import com.jme3.renderer.queue.RenderQueue; * *

This profiler uses the Android Trace class which is only supported * on Android SDK rev 18 and higher (ver 4.3 and higher). If the - * device is running a version < rev 18, the logging will + * device is running a version less than rev 18, the logging will * be skipped.

* *

In the MainActivity class, add the following:

diff --git a/jme3-android/src/main/java/com/jme3/input/android/AndroidJoyInput.java b/jme3-android/src/main/java/com/jme3/input/android/AndroidJoyInput.java index 1e610d24e..6eb2a949f 100644 --- a/jme3-android/src/main/java/com/jme3/input/android/AndroidJoyInput.java +++ b/jme3-android/src/main/java/com/jme3/input/android/AndroidJoyInput.java @@ -71,10 +71,11 @@ import java.util.logging.Logger; * This is done to allow for battery conservation when sensor data or gamepads * are not required by the application. * + * {@code * To use the joystick rumble feature, the following line needs to be * added to the Android Manifest File * - * + * } * @author iwgeric */ public class AndroidJoyInput implements JoyInput { diff --git a/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/constraints/definitions/ConstraintDefinition.java b/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/constraints/definitions/ConstraintDefinition.java index a1f3a7316..166b28c61 100644 --- a/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/constraints/definitions/ConstraintDefinition.java +++ b/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/constraints/definitions/ConstraintDefinition.java @@ -151,7 +151,7 @@ public abstract class ConstraintDefinition { * @param targetTransform * the target transform used by some of the constraints * @param influence - * the influence of the constraint (from range <0; 1>) + * the influence of the constraint from range [0; 1] */ public abstract void bake(Space ownerSpace, Space targetSpace, Transform targetTransform, float influence); diff --git a/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/textures/TextureHelper.java b/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/textures/TextureHelper.java index cd146b109..5b7ccfc9b 100644 --- a/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/textures/TextureHelper.java +++ b/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/textures/TextureHelper.java @@ -313,7 +313,7 @@ public class TextureHelper extends AbstractBlenderHelper { * This method returns the proper pixel position on the image. * * @param pos - * the relative position (value of range <0, 1> (both inclusive)) + * the relative position (value of range [0, 1] (both inclusive)) * @param size * the size of the line the pixel lies on (width, height or * depth) diff --git a/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/textures/TexturePixel.java b/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/textures/TexturePixel.java index 365b34f5e..def3462ed 100644 --- a/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/textures/TexturePixel.java +++ b/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/textures/TexturePixel.java @@ -118,7 +118,7 @@ public class TexturePixel implements Cloneable { /** * This method sets the alpha value (converts it to float number from range - * <0, 1>). + * [0, 1]). * * @param alpha * the alpha value @@ -129,7 +129,7 @@ public class TexturePixel implements Cloneable { /** * This method sets the alpha value (converts it to float number from range - * <0, 1>). + * [0, 1]). * * @param alpha * the alpha value diff --git a/jme3-effects/src/main/java/com/jme3/post/filters/CrossHatchFilter.java b/jme3-effects/src/main/java/com/jme3/post/filters/CrossHatchFilter.java index 4f50e7dd1..9e9451355 100644 --- a/jme3-effects/src/main/java/com/jme3/post/filters/CrossHatchFilter.java +++ b/jme3-effects/src/main/java/com/jme3/post/filters/CrossHatchFilter.java @@ -157,7 +157,7 @@ public class CrossHatchFilter extends Filter { } /** - * Sets line/paper color ratio for areas with values < luminance5, + * Sets line/paper color ratio for areas with values less than luminance5, * really dark areas get no lines but a filled blob instead * @param fillValue */ diff --git a/jme3-effects/src/main/java/com/jme3/water/SimpleWaterProcessor.java b/jme3-effects/src/main/java/com/jme3/water/SimpleWaterProcessor.java index a628514ce..677cc6d20 100644 --- a/jme3-effects/src/main/java/com/jme3/water/SimpleWaterProcessor.java +++ b/jme3-effects/src/main/java/com/jme3/water/SimpleWaterProcessor.java @@ -81,7 +81,7 @@ import com.jme3.ui.Picture; * //attaching the water to the root node * rootNode.attachChild(water); * - * @author Normen Hansen & Rémy Bouquet + * @author Normen Hansen and Rémy Bouquet */ public class SimpleWaterProcessor implements SceneProcessor { diff --git a/jme3-networking/src/main/java/com/jme3/network/base/MessageProtocol.java b/jme3-networking/src/main/java/com/jme3/network/base/MessageProtocol.java index a9130f838..cebb84295 100644 --- a/jme3-networking/src/main/java/com/jme3/network/base/MessageProtocol.java +++ b/jme3-networking/src/main/java/com/jme3/network/base/MessageProtocol.java @@ -99,7 +99,7 @@ public class MessageProtocol * Adds the specified buffer, extracting the contained messages * and making them available to getMessage(). The left over * data is buffered to be combined with future data. - & + * * @return The total number of queued messages after this call. */ public int addBuffer( ByteBuffer buffer ) diff --git a/jme3-terrain/src/main/java/com/jme3/terrain/noise/fractal/FractalSum.java b/jme3-terrain/src/main/java/com/jme3/terrain/noise/fractal/FractalSum.java index 5fe5dcb4a..df2fb235a 100644 --- a/jme3-terrain/src/main/java/com/jme3/terrain/noise/fractal/FractalSum.java +++ b/jme3-terrain/src/main/java/com/jme3/terrain/noise/fractal/FractalSum.java @@ -36,7 +36,7 @@ import com.jme3.terrain.noise.basis.Noise; /** * FractalSum is the simplest form of fractal functions summing up a few octaves - * of the noise value with an ever decreasing (0 < roughness < 1) amplitude + * of the noise value with an ever decreasing roughness (0 to 1) amplitude * * lacunarity = 2.0f is the classical octave distance *