JavaDoc corrections

jMonkeyEngine · Jan 21, 2024 · 4665aaa · 4665aaa
1 parent 7b87ff5
commit 4665aaa
Showing 1 changed file with 12 additions and 12 deletions.
diff --git a/jme3-core/src/main/java/com/jme3/environment/EnvironmentProbeControl.java b/jme3-core/src/main/java/com/jme3/environment/EnvironmentProbeControl.java
@@ -100,7 +100,7 @@ protected EnvironmentProbeControl() {
     }
 
     /**
-     * Create a new environment probe control.
+     * Creates a new environment probe control.
      * 
      * @param assetManager
      *            the asset manager used to load the shaders needed for the
@@ -115,7 +115,7 @@ public EnvironmentProbeControl(AssetManager assetManager, int size) {
     }
 
     /**
-     * Tag spatial as part of the environment for this EnvironmentProbeControl.
+     * Tags the specified spatial as part of the environment for this EnvironmentProbeControl.
      * Only tagged spatials will be rendered in the environment map.
      * 
      * @param s
@@ -133,7 +133,7 @@ public void tag(Spatial s) {
     }
 
     /**
-     * Untag spatial as part of the environment for this
+     * Untags the specified spatial as part of the environment for this
      * EnvironmentProbeControl.
      * 
      * @param s
@@ -151,7 +151,7 @@ public void untag(Spatial s) {
     }
 
     /**
-     * Tag spatial as part of the environment for every EnvironmentProbeControl.
+     * Tags the specified spatial as part of the environment for every EnvironmentProbeControl.
      * Only tagged spatials will be rendered in the environment map.
      * 
      * @param s
@@ -169,7 +169,7 @@ public static void tagGlobal(Spatial s) {
     }
 
     /**
-     * Untag spatial as part of the environment for every
+     * Untags the specified spatial as part of the environment for every
      * EnvironmentProbeControl.
      * 
      * @param s the spatial
@@ -191,7 +191,7 @@ public Control cloneForSpatial(Spatial spatial) {
     }
 
     /**
-     * Request savable results from the baking process. This will make the
+     * Requests savable results from the baking process. This will make the
      * baking process slower and more memory intensive but will allow to
      * serialize the results with the control.
      * 
@@ -203,7 +203,7 @@ public void setRequiredSavableResults(boolean v) {
     }
 
     /**
-     * Return true if savable results are required by this control.
+     * Returns true if savable results are required by this control.
      * 
      * @return true if savable results are required.
      */
@@ -235,14 +235,14 @@ public void render(RenderManager rm, ViewPort vp) {
     }
 
     /**
-     * Schedule a rebake of the environment map.
+     * Schedules a rebake of the environment map.
      */
     public void rebake() {
         bakeNeeded = true;
     }
 
     /**
-     * Set the minimum distance to render
+     * Sets the minimum distance to render.
      * 
      * @param frustumNear the minimum distance to render
      */
@@ -251,7 +251,7 @@ public void setFrustumNear(float frustumNear) {
     }
 
     /**
-     * Set the maximum distance to render
+     * Sets the maximum distance to render.
      * 
      * @param frustumFar the maximum distance to render
      */
@@ -269,7 +269,7 @@ public float getFrustumNear() {
     }
 
     /**
-     * Get the maximum distance to render
+     * Gets the maximum distance to render
      * 
      * @return frustum far
      */
@@ -278,7 +278,7 @@ public float getFrustumFar() {
     }
 
     /**
-     * Set the asset manager used to load the shaders needed for the baking
+     * Sets the asset manager used to load the shaders needed for the baking
      * 
      * @param assetManager the asset manager
      */