resolve javadoc warnings in the jme3-effects library (#1519)

* jme3-effects: resolve javadoc warnings

* jme3-effects/build.gradle: enable doclint

Author: stephengold

jme3-effects/build.gradle

@@ -5,10 +5,3 @@ if (!hasProperty('mainClass')) {
 dependencies {
     compile project(':jme3-core')
 }
-
-javadoc {
-    // Disable doclint for JDK8+.
-    if (JavaVersion.current().isJava8Compatible()){
-        options.addStringOption('Xdoclint:none', '-quiet')
-    }
-}

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

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2019 jMonkeyEngine
+ * Copyright (c) 2009-2021 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -109,7 +109,8 @@ public BloomFilter() {
 
     /**
      * Creates the bloom filter with the specific glow mode
-     * @param glowMode
+     *
+     * @param glowMode the desired mode (default=Scene)
      */
     public BloomFilter(GlowMode glowMode) {
         this();
@@ -234,7 +235,8 @@ public float getBloomIntensity() {
 
     /**
      * intensity of the bloom effect default is 2.0
-     * @param bloomIntensity
+     *
+     * @param bloomIntensity the desired intensity (default=2)
      */
     public void setBloomIntensity(float bloomIntensity) {
         this.bloomIntensity = bloomIntensity;
@@ -250,7 +252,8 @@ public float getBlurScale() {
 
     /**
      * sets The spread of the bloom default is 1.5f
-     * @param blurScale
+     *
+     * @param blurScale the desired scale (default=1.5)
      */
     public void setBlurScale(float blurScale) {
         this.blurScale = blurScale;
@@ -267,7 +270,8 @@ public float getExposureCutOff() {
 
     /**
      * Define the color threshold on which the bloom will be applied (0.0 to 1.0)
-     * @param exposureCutOff
+     *
+     * @param exposureCutOff the desired threshold (≥0, ≤1, default=0)
      */
     public void setExposureCutOff(float exposureCutOff) {
         this.exposureCutOff = exposureCutOff;
@@ -284,8 +288,9 @@ public float getExposurePower() {
 
     /**
      * defines how many time the bloom extracted color will be multiplied by itself. default id 5.0<br>
-     * a high value will reduce rough edges in the bloom and somhow the range of the bloom area     * 
-     * @param exposurePower
+     * a high value will reduce rough edges in the bloom and somhow the range of the bloom area
+     *
+     * @param exposurePower the desired exponent (default=5)
      */
     public void setExposurePower(float exposurePower) {
         this.exposurePower = exposurePower;
@@ -303,7 +308,8 @@ public float getDownSamplingFactor() {
     /**
      * Sets the downSampling factor : the size of the computed texture will be divided by this factor. default is 1 for no downsampling
      * A 2 value is a good way of widening the blur
-     * @param downSamplingFactor
+     *
+     * @param downSamplingFactor the desired factor (default=1)
      */
     public void setDownSamplingFactor(float downSamplingFactor) {
         this.downSamplingFactor = downSamplingFactor;

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

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2019 jMonkeyEngine
+ * Copyright (c) 2009-2021 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -124,7 +124,8 @@ public float getDepthSensitivity() {
     /**
      * sets the depth sensitivity<br>
      * defines how much depth will influence edges, default is 10
-     * @param depthSensitivity 
+     *
+     * @param depthSensitivity the desired sensitivity (default=10)
      */
     public void setDepthSensitivity(float depthSensitivity) {
         this.depthSensitivity = depthSensitivity;
@@ -145,7 +146,8 @@ public float getDepthThreshold() {
     /**
      * sets the depth threshold<br>
      * Defines at what threshold of difference of depth an edge is outlined default is 0.1f
-     * @param depthThreshold 
+     *
+     * @param depthThreshold the desired threshold (default=0.1)
      */
     public void setDepthThreshold(float depthThreshold) {
         this.depthThreshold = depthThreshold;
@@ -166,7 +168,8 @@ public float getEdgeIntensity() {
     /**
      * sets the edge intensity<br>
      * Defineshow visible will be the outlined edges
-     * @param edgeIntensity 
+     *
+     * @param edgeIntensity the desired intensity (default=1)
      */
     public void setEdgeIntensity(float edgeIntensity) {
         this.edgeIntensity = edgeIntensity;
@@ -185,7 +188,8 @@ public float getEdgeWidth() {
 
     /**
      * sets the witdh of the edge in pixels default is 1
-     * @param edgeWidth 
+     *
+     * @param edgeWidth the desired width (in pixels, default=1)
      */
     public void setEdgeWidth(float edgeWidth) {
         this.edgeWidth = edgeWidth;
@@ -206,7 +210,8 @@ public float getNormalSensitivity() {
 
     /**
      * sets the normals sensitivity default is 1
-     * @param normalSensitivity 
+     *
+     * @param normalSensitivity the desired sensitivity (default=1)
      */
     public void setNormalSensitivity(float normalSensitivity) {
         this.normalSensitivity = normalSensitivity;
@@ -227,7 +232,8 @@ public float getNormalThreshold() {
 
     /**
      * sets the normal threshold default is 0.5
-     * @param normalThreshold 
+     *
+     * @param normalThreshold the desired threshold (default=0.5)
      */
     public void setNormalThreshold(float normalThreshold) {
         this.normalThreshold = normalThreshold;
@@ -246,7 +252,8 @@ public ColorRGBA getEdgeColor() {
 
     /**
      * Sets the edge color, default is black
-     * @param edgeColor
+     *
+     * @param edgeColor the desired color (alias created, default=(0,0,0,1))
      */
     public void setEdgeColor(ColorRGBA edgeColor) {
         this.edgeColor = edgeColor;

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

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2021 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -61,7 +61,8 @@ public ColorOverlayFilter() {
 
     /**
      * creates a colorOverlayFilter with the given color
-     * @param color 
+     *
+     * @param color the desired color (default=(1,1,1,1), alias created)
      */
     public ColorOverlayFilter(ColorRGBA color) {
         this();
@@ -82,8 +83,9 @@ public ColorRGBA getColor() {
     }
 
     /**
-     * sets the color 
-     * @param color 
+     * sets the color
+     *
+     * @param color the desired color (default=(1,1,1,1), alias created)
      */
     public void setColor(final ColorRGBA color) {
         this.color = color;

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

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2019 jMonkeyEngine
+ * Copyright (c) 2009-2021 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -68,7 +68,7 @@ public ComposeFilter() {
     /**
      * creates a ComposeFilter with the given texture
      *
-     * @param compositeTexture
+     * @param compositeTexture the texture to use (alias created)
      */
     public ComposeFilter(Texture2D compositeTexture) {
         this();
@@ -93,7 +93,7 @@ public Texture2D getCompositeTexture() {
     /**
      * sets the compositeTexture
      *
-     * @param compositeTexture
+     * @param compositeTexture the desired texture (alias created)
      */
     public void setCompositeTexture(Texture2D compositeTexture) {
         this.compositeTexture = compositeTexture;

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

@@ -114,7 +114,8 @@ protected Material getMaterial() {
 
     /**
      * Sets color used to draw lines
-     * @param lineColor 
+     *
+     * @param lineColor the desired color (alias created, default=(0,0,0,1))
      */
     public void setLineColor(ColorRGBA lineColor) {
         this.lineColor = lineColor;
@@ -125,7 +126,8 @@ public void setLineColor(ColorRGBA lineColor) {
 
     /**
      * Sets color used as background
-     * @param paperColor 
+     *
+     * @param paperColor the desired color (alias created, default=(1,1,1,1))
      */
     public void setPaperColor(ColorRGBA paperColor) {
         this.paperColor = paperColor;
@@ -136,7 +138,8 @@ public void setPaperColor(ColorRGBA paperColor) {
 
     /**
      * Sets color influence of original image on lines drawn
-     * @param colorInfluenceLine 
+     *
+     * @param colorInfluenceLine the desired factor (default=0.8) 
      */
     public void setColorInfluenceLine(float colorInfluenceLine) {
         this.colorInfluenceLine = colorInfluenceLine;
@@ -147,7 +150,8 @@ public void setColorInfluenceLine(float colorInfluenceLine) {
 
     /**
      * Sets color influence of original image on non-line areas
-     * @param colorInfluencePaper 
+     *
+     * @param colorInfluencePaper the desired factor (default=0.1)
      */
     public void setColorInfluencePaper(float colorInfluencePaper) {
         this.colorInfluencePaper = colorInfluencePaper;
@@ -159,7 +163,8 @@ public void setColorInfluencePaper(float colorInfluencePaper) {
     /**
      * 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 
+     *
+     * @param fillValue the desired ratio (default=0.9)
      */
     public void setFillValue(float fillValue) {
         this.fillValue = fillValue;
@@ -195,7 +200,8 @@ public void setLuminanceLevels(float luminance1, float luminance2, float luminan
 
     /**
      * Sets the thickness of lines drawn
-     * @param lineThickness 
+     *
+     * @param lineThickness the desired thickness (in pixels, default=1)
      */
     public void setLineThickness(float lineThickness) {
         this.lineThickness = lineThickness;
@@ -208,7 +214,8 @@ public void setLineThickness(float lineThickness) {
      * Sets minimum distance between lines drawn
      * Primary lines are drawn at 2*lineDistance
      * Secondary lines are drawn at lineDistance
-     * @param lineDistance 
+     *
+     * @param lineDistance the desired distance (in pixels, default=4)
      */
     public void setLineDistance(float lineDistance) {
         this.lineDistance = lineDistance;
@@ -235,69 +242,89 @@ public ColorRGBA getPaperColor() {
 
     /**
      * Returns current influence of image colors on lines
+     *
+     * @return the influence factor
      */
     public float getColorInfluenceLine() {
         return colorInfluenceLine;
     }
 
     /**
      * Returns current influence of image colors on paper background
+     *
+     * @return the influence factor
      */
     public float getColorInfluencePaper() {
         return colorInfluencePaper;
     }
 
     /**
      * Returns line/paper color ratio for blobs
+     *
+     * @return the ratio
      */
     public float getFillValue() {
         return fillValue;
     }
 
     /**
      * Returns the thickness of the lines drawn
+     *
+     * @return the thickness (in pixels)
      */
     public float getLineThickness() {
         return lineThickness;
     }
 
     /**
      * Returns minimum distance between lines
+     *
+     * @return the distance (in pixels)
      */
     public float getLineDistance() {
         return lineDistance;
     }
 
     /**
      * Returns threshold for lines 1
+     *
+     * @return the first luminance threshold
      */
     public float getLuminance1() {
         return luminance1;
     }
 
     /**
      * Returns threshold for lines 2
+     *
+     * @return the 2nd luminance threshold
      */
     public float getLuminance2() {
         return luminance2;
     }
 
     /**
      * Returns threshold for lines 3
+     *
+     * @return the 3rd luminance threshold
      */
     public float getLuminance3() {
         return luminance3;
     }
 
     /**
      * Returns threshold for lines 4
+     *
+     * @return the 4th luminance threshold
      */
     public float getLuminance4() {
         return luminance4;
     }
 
     /**
      * Returns threshold for blobs
+     *
+     * @return the 5th luminance threshold
      */
     public float getLuminance5() {
         return luminance5;