Преглед изворни кода

jme3-effects: correct some typos/inaccuracies in the javadoc

Stephen Gold пре 4 година
родитељ
комит
90dce70af2

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

@@ -51,7 +51,7 @@ import java.util.ArrayList;
  * BloomFilter is used to make objects in the scene have a glow effect.<br>
  * 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>
+ * Object mode makes 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
  * 
  * @author Rémy Bouquet aka Nehon
@@ -59,7 +59,7 @@ import java.util.ArrayList;
 public class BloomFilter extends Filter {
 
     /**
-     * GlowMode specifies if the glow will be applied to the whole scene,or to objects that have aglow color or a glow map
+     * GlowMode specifies if the glow will be applied to the whole scene or to objects that have a glow color or a glow map
      */
     public enum GlowMode {
 
@@ -108,7 +108,7 @@ public class BloomFilter extends Filter {
     }
 
     /**
-     * Creates the bloom filter with the specific glow mode
+     * Creates the bloom filter with the specified glow mode
      *
      * @param glowMode the desired mode (default=Scene)
      */
@@ -287,8 +287,8 @@ public class BloomFilter extends Filter {
     }
 
     /**
-     * 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
+     * defines how many times the bloom extracted color will be multiplied by itself. default is 5.0<br>
+     * a high value will reduce rough edges in the bloom and somehow the range of the bloom area
      *
      * @param exposurePower the desired exponent (default=5)
      */

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

@@ -167,7 +167,7 @@ public class CartoonEdgeFilter extends Filter {
 
     /**
      * sets the edge intensity<br>
-     * Defineshow visible will be the outlined edges
+     * Defines how visible the outlined edges will be
      *
      * @param edgeIntensity the desired intensity (default=1)
      */
@@ -187,7 +187,7 @@ public class CartoonEdgeFilter extends Filter {
     }
 
     /**
-     * sets the witdh of the edge in pixels default is 1
+     * sets the width of the edge in pixels default is 1
      *
      * @param edgeWidth the desired width (in pixels, default=1)
      */

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

@@ -176,9 +176,9 @@ public class CrossHatchFilter extends Filter {
     /**
      *
      * Sets minimum luminance levels for lines drawn
-     * @param luminance1 Top-left to down right 1
+     * @param luminance1 Top-left to bottom right 1
      * @param luminance2 Top-right to bottom left 1
-     * @param luminance3 Top-left to down right 2
+     * @param luminance3 Top-left to bottom right 2
      * @param luminance4 Top-right to bottom left 2
      * @param luminance5 Blobs
      */

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

@@ -142,7 +142,7 @@ public class FogFilter extends Filter {
     }
 
     /**
-     * the distance of the fog. the higer the value the distant the fog looks
+     * the distance of the fog. the higher the value the distant the fog looks
      *
      * @param fogDistance the desired distance (in world units, default=1000)
      */

+ 1 - 1
jme3-effects/src/main/java/com/jme3/post/filters/PosterizationFilter.java

@@ -109,7 +109,7 @@ public class PosterizationFilter extends Filter {
     }
 
     /**
-     * Sets gamma level used to enhange visual quality
+     * Sets gamma level used to enhance visual quality
      * 
      * @param gamma the desired exponent (default=0.6)
      */

+ 1 - 1
jme3-effects/src/main/java/com/jme3/post/ssao/SSAOFilter.java

@@ -227,7 +227,7 @@ public class SSAOFilter extends Filter {
     }
 
     /**
-     * Sets the Ambient occlusion intensity default is 1.2f
+     * Sets the Ambient occlusion intensity default is 1.5
      *
      * @param intensity the desired intensity (default=1.5)
      */

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

@@ -418,7 +418,7 @@ public class SimpleWaterProcessor implements SceneProcessor {
 
     /**
      * Higher values make the refraction texture shine through earlier.
-     * Default is 4
+     * Default is 1
      *
      * @param depth the desired depth (default=1)
      */
@@ -444,7 +444,7 @@ public class SimpleWaterProcessor implements SceneProcessor {
     }
 
     /**
-     * sets the water transparency default os 0.1f
+     * sets the water transparency default is 0.4f
      *
      * @param waterTransparency the desired transparency (default=0.4)
      */
@@ -575,7 +575,7 @@ public class SimpleWaterProcessor implements SceneProcessor {
 
     /**
      * sets the reflection clipping plane offset
-     * set a nagetive value to lower the clipping plane for relection texture rendering.
+     * set a negative value to lower the clipping plane for relection texture rendering.
      *
      * @param reflectionClippingOffset the desired offset (default=-5)
      */

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

@@ -550,7 +550,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
     /**
      * Sets the normal scaling factors to apply to the normal map.
      * the higher the value the more small ripples will be visible on the waves.
-     * default is 1.0
+     * default is 3
      *
      * @param normalScale the scaling factor (default=3)
      */
@@ -574,7 +574,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
      * F = R0 + (1-R0)( 1 - N.V)^5
      * where F is the fresnel term, R0 the constant, N the normal vector and V the view vector.
      * It usually depend on the material you are looking through (here water).
-     * Default value is 0.3f
+     * Default value is 0.5
      * In practice, the lowest the value and the less the reflection can be seen on water
      *
      * @param refractionConstant the desired R0 value (default=0.5)
@@ -596,7 +596,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
 
     /**
      * Sets the maximum waves amplitude
-     * default is 1.0
+     * default is 1.5
      *
      * @param maxAmplitude the desired maximum amplitude (default=1.5)
      */
@@ -650,7 +650,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
     }
 
     /**
-     * Return the shoreHardeness
+     * Return the shore hardness.
      * @return the hardness value
      */
     public float getShoreHardness() {
@@ -921,7 +921,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
     /**
      * Sets the color of the water
      * see setDeepWaterColor for deep water color
-     * default is (0.0078f, 0.5176f, 0.5f,1.0f) (greenish blue)
+     * default is (0.0078f, 0.3176f, 0.5f,1.0f) (greenish blue)
      *
      * @param waterColor the color to use (alias created,
      * default=(0.0078,0.3176,0.5,1))