Преглед на файлове

simple corrections to comments/javadoc (M-Z)

Stephen Gold преди 3 години
родител
ревизия
c7d82696b8
променени са 91 файла, в които са добавени 208 реда и са изтрити 212 реда
  1. 2 2
      jme3-bullet/src/common/java/com/jme3/bullet/PhysicsTickListener.java
  2. 2 2
      jme3-core/src/main/java/com/jme3/anim/SeparateJointModelTransform.java
  3. 2 2
      jme3-core/src/main/java/com/jme3/anim/SkinningControl.java
  4. 1 2
      jme3-core/src/main/java/com/jme3/animation/SkeletonControl.java
  5. 1 1
      jme3-core/src/main/java/com/jme3/app/SimpleApplication.java
  6. 3 3
      jme3-core/src/main/java/com/jme3/app/state/ScreenshotAppState.java
  7. 1 1
      jme3-core/src/main/java/com/jme3/asset/cache/WeakRefAssetCache.java
  8. 2 2
      jme3-core/src/main/java/com/jme3/asset/cache/WeakRefCloneAssetCache.java
  9. 1 1
      jme3-core/src/main/java/com/jme3/bounding/OrientedBoundingBox.java
  10. 5 5
      jme3-core/src/main/java/com/jme3/effect/ParticleEmitter.java
  11. 1 1
      jme3-core/src/main/java/com/jme3/effect/influencers/ParticleInfluencer.java
  12. 1 1
      jme3-core/src/main/java/com/jme3/input/SensorJoystickAxis.java
  13. 1 1
      jme3-core/src/main/java/com/jme3/light/OrientedBoxProbeArea.java
  14. 1 1
      jme3-core/src/main/java/com/jme3/material/logic/SinglePassAndImageBasedLightingLogic.java
  15. 1 1
      jme3-core/src/main/java/com/jme3/material/logic/SinglePassLightingLogic.java
  16. 4 4
      jme3-core/src/main/java/com/jme3/math/Quaternion.java
  17. 1 1
      jme3-core/src/main/java/com/jme3/math/Ray.java
  18. 1 1
      jme3-core/src/main/java/com/jme3/math/Rectangle.java
  19. 1 1
      jme3-core/src/main/java/com/jme3/math/Ring.java
  20. 3 3
      jme3-core/src/main/java/com/jme3/math/Spline.java
  21. 1 1
      jme3-core/src/main/java/com/jme3/opencl/Program.java
  22. 5 5
      jme3-core/src/main/java/com/jme3/opencl/package-info.java
  23. 9 10
      jme3-core/src/main/java/com/jme3/renderer/RenderManager.java
  24. 4 4
      jme3-core/src/main/java/com/jme3/renderer/Renderer.java
  25. 5 5
      jme3-core/src/main/java/com/jme3/scene/Node.java
  26. 24 24
      jme3-core/src/main/java/com/jme3/scene/Spatial.java
  27. 1 1
      jme3-core/src/main/java/com/jme3/scene/package.html
  28. 2 2
      jme3-core/src/main/java/com/jme3/scene/shape/Surface.java
  29. 5 5
      jme3-core/src/main/java/com/jme3/shader/Shader.java
  30. 7 7
      jme3-core/src/main/java/com/jme3/shader/ShaderGenerator.java
  31. 1 1
      jme3-core/src/main/java/com/jme3/shader/ShaderNode.java
  32. 1 1
      jme3-core/src/main/java/com/jme3/shader/ShaderVariable.java
  33. 1 1
      jme3-core/src/main/java/com/jme3/shadow/PssmShadowFilter.java
  34. 1 1
      jme3-core/src/main/java/com/jme3/shadow/PssmShadowUtil.java
  35. 1 1
      jme3-core/src/main/java/com/jme3/shadow/ShadowUtil.java
  36. 2 2
      jme3-core/src/main/java/com/jme3/ui/Picture.java
  37. 3 3
      jme3-core/src/main/java/com/jme3/util/SafeArrayList.java
  38. 1 1
      jme3-core/src/main/java/com/jme3/util/TangentBinormalGenerator.java
  39. 0 1
      jme3-core/src/main/java/com/jme3/util/xml/SAXUtil.java
  40. 5 5
      jme3-core/src/plugins/java/com/jme3/material/plugins/ShaderNodeLoaderDelegate.java
  41. 1 1
      jme3-core/src/test/java/com/jme3/scene/PhantomTrianglesTest.java
  42. 1 1
      jme3-desktop/src/main/java/com/jme3/app/SettingsDialog.java
  43. 4 4
      jme3-desktop/src/main/java/com/jme3/system/NativeLibraryLoader.java
  44. 1 1
      jme3-effects/src/main/java/com/jme3/post/ssao/SSAOFilter.java
  45. 2 2
      jme3-effects/src/main/java/com/jme3/water/SimpleWaterProcessor.java
  46. 1 1
      jme3-effects/src/main/java/com/jme3/water/WaterFilter.java
  47. 0 1
      jme3-examples/src/main/java/jme3test/batching/TestBatchNodeCluster.java
  48. 2 2
      jme3-examples/src/main/java/jme3test/games/WorldOfInception.java
  49. 1 1
      jme3-examples/src/main/java/jme3test/network/TestLatency.java
  50. 3 3
      jme3-examples/src/main/java/jme3test/post/TestPostFiltersCompositing.java
  51. 1 1
      jme3-examples/src/main/java/jme3test/renderer/TestBackgroundImage.java
  52. 1 1
      jme3-examples/src/main/java/jme3test/renderer/TestContextRestart.java
  53. 2 2
      jme3-examples/src/main/java/jme3test/terrain/PBRTerrainAdvancedTest.java
  54. 2 2
      jme3-examples/src/main/java/jme3test/terrain/PBRTerrainTest.java
  55. 1 1
      jme3-examples/src/main/java/jme3test/terrain/TerrainTestAndroid.java
  56. 1 1
      jme3-examples/src/main/java/jme3test/texture/TestTexture3D.java
  57. 2 2
      jme3-jbullet/src/main/java/com/jme3/bullet/PhysicsSpace.java
  58. 3 3
      jme3-jbullet/src/main/java/com/jme3/bullet/joints/SixDofJoint.java
  59. 1 1
      jme3-jbullet/src/main/java/com/jme3/bullet/objects/PhysicsCharacter.java
  60. 2 2
      jme3-jbullet/src/main/java/com/jme3/bullet/objects/PhysicsRigidBody.java
  61. 4 4
      jme3-jbullet/src/main/java/com/jme3/bullet/objects/PhysicsVehicle.java
  62. 2 2
      jme3-jbullet/src/main/java/com/jme3/bullet/objects/infos/RigidBodyMotionState.java
  63. 2 2
      jme3-jogg/src/main/java/com/jme3/audio/plugins/OGGLoader.java
  64. 1 1
      jme3-networking/src/main/java/com/jme3/network/Network.java
  65. 1 1
      jme3-networking/src/main/java/com/jme3/network/NetworkClient.java
  66. 1 1
      jme3-networking/src/main/java/com/jme3/network/Server.java
  67. 6 6
      jme3-networking/src/main/java/com/jme3/network/kernel/tcp/SelectorKernel.java
  68. 4 4
      jme3-networking/src/main/java/com/jme3/network/message/SerializerRegistrationsMessage.java
  69. 1 1
      jme3-networking/src/main/java/com/jme3/network/rmi/ObjectStore.java
  70. 2 2
      jme3-networking/src/main/java/com/jme3/network/serializing/Serializer.java
  71. 2 2
      jme3-networking/src/main/java/com/jme3/network/service/ServiceManager.java
  72. 6 6
      jme3-networking/src/main/java/com/jme3/network/service/rmi/RmiHostedService.java
  73. 1 1
      jme3-networking/src/main/java/com/jme3/network/service/rmi/RmiRegistry.java
  74. 1 1
      jme3-networking/src/main/java/com/jme3/network/service/rpc/RpcClientService.java
  75. 1 1
      jme3-networking/src/main/java/com/jme3/network/service/rpc/RpcConnection.java
  76. 1 1
      jme3-networking/src/main/java/com/jme3/network/service/rpc/RpcHostedService.java
  77. 2 2
      jme3-niftygui/src/main/java/com/jme3/niftygui/NiftyJmeDisplay.java
  78. 1 1
      jme3-niftygui/src/main/java/com/jme3/niftygui/SoundHandleJme.java
  79. 2 2
      jme3-plugins/src/ogre/java/com/jme3/scene/plugins/ogre/SceneLoader.java
  80. 1 1
      jme3-plugins/src/xml/java/com/jme3/export/xml/XMLExporter.java
  81. 2 2
      jme3-terrain/src/main/java/com/jme3/terrain/heightmap/RawHeightMap.java
  82. 1 1
      jme3-vr/src/main/java/com/jme3/input/vr/VRAPI.java
  83. 1 1
      jme3-vr/src/main/java/com/jme3/input/vr/VRInputAPI.java
  84. 1 1
      jme3-vr/src/main/java/com/jme3/input/vr/oculus/OculusVR.java
  85. 1 1
      jme3-vr/src/main/java/com/jme3/input/vr/openvr/OpenVR.java
  86. 2 2
      jme3-vr/src/main/java/com/jme3/input/vr/openvr/OpenVRViewManager.java
  87. 3 3
      jme3-vr/src/main/java/com/jme3/input/vr/osvr/OSVR.java
  88. 2 2
      jme3-vr/src/main/java/com/jme3/input/vr/osvr/OSVRInput.java
  89. 4 4
      jme3-vr/src/main/java/com/jme3/input/vr/osvr/OSVRViewManager.java
  90. 1 1
      jme3-vr/src/main/java/com/jme3/post/PreNormalCaching.java
  91. 2 2
      jme3-vr/src/main/java/com/jme3/system/osvr/osvrdisplay/OsvrDisplayLibrary.java

+ 2 - 2
jme3-bullet/src/common/java/com/jme3/bullet/PhysicsTickListener.java

@@ -50,8 +50,8 @@ public interface PhysicsTickListener {
     public void prePhysicsTick(PhysicsSpace space, float tpf);
 
     /**
-     * Callback from Bullet, invoked just after the physics has been stepped,
-     * use to check for forces etc.
+     * Callback from Bullet, invoked just after the physics has been stepped.
+     * Use it to check for forces etc.
      *
      * @param space the space that was just stepped (not null)
      * @param tpf the time per physics step (in seconds, ≥0)

+ 2 - 2
jme3-core/src/main/java/com/jme3/anim/SeparateJointModelTransform.java

@@ -6,10 +6,10 @@ import com.jme3.math.Transform;
 
 /**
  * This JointModelTransform implementation accumulates model transform in a Transform class
- * This does NOT support proper non uniform scale in the armature hierarchy.
+ * This does NOT support proper nonuniform scale in the armature hierarchy.
  * But the effect might be useful in some circumstances.
  * Note that this is how the old animation system was working, so you might want to use this
- * if your model has non uniform scale and was migrated from old j3o model.
+ * if your model has nonuniform scale and was migrated from an old j3o model.
  */
 public class SeparateJointModelTransform implements JointModelTransform {
 

+ 2 - 2
jme3-core/src/main/java/com/jme3/anim/SkinningControl.java

@@ -182,7 +182,7 @@ public class SkinningControl extends AbstractControl implements Cloneable, JmeCl
 
     /**
      * Specifies if hardware skinning is preferred. If it is preferred and
-     * supported by GPU, it shall be enabled, if its not preferred, or not
+     * supported by GPU, it shall be enabled.  If it's not preferred, or not
      * supported by GPU, then it shall be disabled.
      *
      * @param preferred true to prefer hardware skinning, false to prefer 
@@ -619,7 +619,7 @@ public class SkinningControl extends AbstractControl implements Cloneable, JmeCl
             ftb.get(tanBuf, 0, tanLength);
             int verts = bufLength / 3;
             int idxPositions = 0;
-            //tangents has their own index because of the 4 components
+            // Tangents have their own index because they have 4 components.
             int idxTangents = 0;
 
             // iterate vertices and apply skinning transform for each effecting bone

+ 1 - 2
jme3-core/src/main/java/com/jme3/animation/SkeletonControl.java

@@ -558,7 +558,6 @@ public class SkeletonControl extends AbstractControl implements Cloneable, JmeCl
      * has additional indexes since tangent has 4 components instead of 3 for
      * pos and norm
      *
-     * @param maxWeightsPerVert maximum number of weights per vertex
      * @param mesh the mesh
      * @param offsetMatrices the offset matrices to apply
      * @param tb the tangent vertexBuffer
@@ -616,7 +615,7 @@ public class SkeletonControl extends AbstractControl implements Cloneable, JmeCl
             ftb.get(tanBuf, 0, tanLength);
             int verts = bufLength / 3;
             int idxPositions = 0;
-            //tangents has their own index because of the 4 components
+            // Tangents have their own index because they have 4 components.
             int idxTangents = 0;
 
             // iterate vertices and apply skinning transform for each effecting bone

+ 1 - 1
jme3-core/src/main/java/com/jme3/app/SimpleApplication.java

@@ -230,7 +230,7 @@ public abstract class SimpleApplication extends LegacyApplication {
         }
 
         if (stateManager.getState(StatsAppState.class) != null) {
-            // Some of the tests rely on having access to fpsText
+            // Some tests rely on having access to fpsText
             // for quick display.  Maybe a different way would be better.
             stateManager.getState(StatsAppState.class).setFont(guiFont);
             fpsText = stateManager.getState(StatsAppState.class).getFpsText();

+ 3 - 3
jme3-core/src/main/java/com/jme3/app/state/ScreenshotAppState.java

@@ -115,7 +115,7 @@ public class ScreenshotAppState extends AbstractAppState implements ActionListen
      * Use an empty string to use the application folder. Use NULL to use the system
      * default storage folder.
      * @param filePath The screenshot file path to use. Include the separator at the end of the path.
-     * @param shotIndex The base index for screen shots.  The first screen shot will have
+     * @param shotIndex The base index for screenshots.  The first screenshot will have
      *                  shotIndex + 1 appended, the next shotIndex + 2, and so on.
      */
     public ScreenshotAppState(String filePath, long shotIndex) {
@@ -131,7 +131,7 @@ public class ScreenshotAppState extends AbstractAppState implements ActionListen
      * default storage folder.
      * @param filePath The screenshot file path to use. Include the separator at the end of the path.
      * @param fileName The name of the file to save the screenshot as.
-     * @param shotIndex The base index for screen shots.  The first screen shot will have
+     * @param shotIndex The base index for screenshots.  The first screenshot will have
      *                  shotIndex + 1 appended, the next shotIndex + 2, and so on.
      */
     public ScreenshotAppState(String filePath, String fileName, long shotIndex) {
@@ -160,7 +160,7 @@ public class ScreenshotAppState extends AbstractAppState implements ActionListen
     }
 
     /**
-     * Sets the base index that will used for subsequent screen shots. 
+     * Sets the base index that will used for subsequent screenshots.
      *
      * @param index the desired base index
      */

+ 1 - 1
jme3-core/src/main/java/com/jme3/asset/cache/WeakRefAssetCache.java

@@ -89,7 +89,7 @@ public class WeakRefAssetCache implements AssetCache {
         removeCollectedAssets();
         
         // NOTE: Some thread issues can happen if another
-        // thread is loading an asset with the same key ..
+        // thread is loading an asset with the same key.
         AssetRef ref = new AssetRef(key, obj, refQueue);
         assetCache.put(key, ref);
     }

+ 2 - 2
jme3-core/src/main/java/com/jme3/asset/cache/WeakRefCloneAssetCache.java

@@ -81,8 +81,8 @@ public class WeakRefCloneAssetCache implements AssetCache {
     /**
      * Stores the original key and original asset.
      * The asset info contains a cloneable asset (e.g. the original, from
-     * which all clones are made). Also a weak reference to the 
-     * original key which is used when the clones are produced.
+     * which all clones are made) and also a weak reference to the
+     * original key, which is used when the clones are produced.
      */
     private static final class AssetRef extends WeakReference<AssetKey> {
 

+ 1 - 1
jme3-core/src/main/java/com/jme3/bounding/OrientedBoundingBox.java

@@ -1381,7 +1381,7 @@ package com.jme3.bounding;
 //     */
 //    private boolean clip(float denom, float numer, float[] t) {
 //        // Return value is 'true' if line segment intersects the current test
-//        // plane. Otherwise 'false' is returned in which case the line segment
+//        // plane. Otherwise, 'false' is returned, in which case the line segment
 //        // is entirely clipped.
 //        if (denom > 0.0f) {
 //            if (numer > denom * t[1])

+ 5 - 5
jme3-core/src/main/java/com/jme3/effect/ParticleEmitter.java

@@ -69,7 +69,7 @@ import java.io.IOException;
  * simulation. The interpretation of these properties depends on the
  * {@link ParticleInfluencer} that has been assigned to the emitter via
  * {@link ParticleEmitter#setParticleInfluencer(com.jme3.effect.influencers.ParticleInfluencer) }.
- * By default the implementation {@link DefaultParticleInfluencer} is used.
+ * By default, the {@link DefaultParticleInfluencer} implementation is used.
  *
  * @author Kirill Vainer
  */
@@ -248,7 +248,7 @@ public class ParticleEmitter extends Geometry {
         // 3) the particles array is recreated because setNumParticles()
         //
         // ...so this should be equivalent but simpler than half of the old clone()
-        // method.  Note: we do not ever want to share particleMesh so we do not
+        // method.  Note: we do not ever want to share particleMesh, so we do not
         // clone it at all.
         setMeshType(meshType);
 
@@ -425,7 +425,7 @@ public class ParticleEmitter extends Geometry {
         for (int i = 0; i < numParticles; i++) {
             particles[i] = new Particle();
         }
-        //We have to reinit the mesh's buffers with the new size
+        // We must reinitialize the mesh's buffers to the new size.
         particleMesh.initParticleData(this, particles.length);
         particleMesh.setImagesXY(this.imagesX, this.imagesY);
         firstUnUsed = 0;
@@ -470,7 +470,7 @@ public class ParticleEmitter extends Geometry {
      * Sets the normal which particles are facing.
      *
      * <p>By default, particles
-     * will face the camera, but for some effects (e.g shockwave) it may
+     * will face the camera, but for some effects (e.g. shockwave) it may
      * be necessary to face a specific direction instead. To restore
      * normal functionality, provide <code>null</code> as the argument for
      * <code>faceNormal</code>.
@@ -580,7 +580,7 @@ public class ParticleEmitter extends Geometry {
      * Set to true if particles spawned should face
      * their velocity (or direction to which they are moving towards).
      *
-     * <p>This is typically used for e.g spark effects.
+     * <p>This is typically used for e.g. spark effects.
      *
      * @param followVelocity True if particles spawned should face their velocity.
      *

+ 1 - 1
jme3-core/src/main/java/com/jme3/effect/influencers/ParticleInfluencer.java

@@ -49,7 +49,7 @@ public interface ParticleInfluencer extends Savable, Cloneable, JmeCloneable {
      * @param particle
      *        particle to be influenced
      * @param emitterShape
-     *        the shape of it emitter
+     *        the shape of its emitter
      */
     void influenceParticle(Particle particle, EmitterShape emitterShape);
 

+ 1 - 1
jme3-core/src/main/java/com/jme3/input/SensorJoystickAxis.java

@@ -33,7 +33,7 @@ package com.jme3.input;
 
 /**
  * Represents a joystick axis based on an external sensor
- * (ie. Android Device Orientation sensors)
+ * (i.e. Android Device Orientation sensors)
  * Sensor joystick axes can be calibrated to 
  * set the zero position dynamically
  * 

+ 1 - 1
jme3-core/src/main/java/com/jme3/light/OrientedBoxProbeArea.java

@@ -152,7 +152,7 @@ public class OrientedBoxProbeArea implements ProbeArea {
         r[1] = transform.getScale().y;
         r[2] = transform.getScale().z;
 
-        // computing closest point to sphere center
+        // Compute the closest point to sphere's center.
         for (int i = 0; i < 3; i++) {
             // extract the axis from the 3x3 matrix
             Vector3f axis = getScaledAxis(i, vars.vect1);

+ 1 - 1
jme3-core/src/main/java/com/jme3/material/logic/SinglePassAndImageBasedLightingLogic.java

@@ -99,7 +99,7 @@ public final class SinglePassAndImageBasedLightingLogic extends DefaultTechnique
      * <p>
      * <code>uniform vec4 g_LightColor[numLights];</code> //
      * g_LightColor.rgb is the diffuse/specular color of the light. //
-     * g_Lightcolor.a is the type of light, 0 = Directional, 1 = Point, 2 = Spot.
+     * g_LightColor.a is the type of light, 0 = Directional, 1 = Point, 2 = Spot.
      * <code>uniform vec4 g_LightPosition[numLights];</code> //
      * g_LightPosition.xyz is the position of the light (for point lights)
      * // or the direction of the light (for directional lights). //

+ 1 - 1
jme3-core/src/main/java/com/jme3/material/logic/SinglePassLightingLogic.java

@@ -89,7 +89,7 @@ public final class SinglePassLightingLogic extends DefaultTechniqueDefLogic {
      * <p>
      * <code>uniform vec4 g_LightColor[numLights];</code><br> //
      * g_LightColor.rgb is the diffuse/specular color of the light.<br> //
-     * g_Lightcolor.a is the type of light, 0 = Directional, 1 = Point, <br> //
+     * g_LightColor.a is the type of light, 0 = Directional, 1 = Point, <br> //
      * 2 = Spot. <br> <br>
      * <code>uniform vec4 g_LightPosition[numLights];</code><br> //
      * g_LightPosition.xyz is the position of the light (for point lights)<br>

+ 4 - 4
jme3-core/src/main/java/com/jme3/math/Quaternion.java

@@ -988,8 +988,8 @@ public final class Quaternion implements Savable, Cloneable, java.io.Serializabl
      * <code>fromAxes</code> creates a <code>Quaternion</code> that
      * represents the coordinate system defined by three axes. These axes are
      * assumed to be orthogonal and no error checking is applied. Thus, the user
-     * must insure that the three axes being provided indeed represents a proper
-     * right handed coordinate system.
+     * must ensure that the three axes being provided represent a proper
+     * right-handed coordinate system.
      *
      * @param axis
      *            the array containing the three vectors representing the
@@ -1009,8 +1009,8 @@ public final class Quaternion implements Savable, Cloneable, java.io.Serializabl
      * <code>fromAxes</code> creates a <code>Quaternion</code> that
      * represents the coordinate system defined by three axes. These axes are
      * assumed to be orthogonal and no error checking is applied. Thus, the user
-     * must insure that the three axes being provided indeed represents a proper
-     * right handed coordinate system.
+     * must ensure that the three axes being provided represent a proper
+     * right-handed coordinate system.
      *
      * @param xAxis vector representing the x-axis of the coordinate system.
      * @param yAxis vector representing the y-axis of the coordinate system.

+ 1 - 1
jme3-core/src/main/java/com/jme3/math/Ray.java

@@ -255,7 +255,7 @@ public final class Ray implements Savable, Cloneable, Collidable, java.io.Serial
                         } else {
                             // these weights can be used to determine
                             // interpolated values, such as texture coord.
-                            // eg. texcoord s,t at intersection point:
+                            // e.g. texcoord s,t at intersection point:
                             // s = w0*s0 + w1*s1 + w2*s2;
                             // t = w0*t0 + w1*t1 + w2*t2;
                             float w1 = dirDotDiffxEdge2 * inv;

+ 1 - 1
jme3-core/src/main/java/com/jme3/math/Rectangle.java

@@ -35,7 +35,7 @@ import com.jme3.export.*;
 import java.io.IOException;
 
 /**
- * <code>Rectangle</code> defines a finite plane within three dimensional space
+ * <code>Rectangle</code> defines a finite plane within three-dimensional space
  * that is specified via three points (A, B, C). These three points define a
  * triangle with the fourth point defining the rectangle (B + C) - A.
  *

+ 1 - 1
jme3-core/src/main/java/com/jme3/math/Ring.java

@@ -35,7 +35,7 @@ import com.jme3.export.*;
 import java.io.IOException;
 
 /**
- * <code>Ring</code> defines a flat ring or disk within three dimensional
+ * <code>Ring</code> defines a flat ring or disc in three-dimensional
  * space that is specified via the ring's center point, an up vector, an inner
  * radius, and an outer radius.
  *

+ 3 - 3
jme3-core/src/main/java/com/jme3/math/Spline.java

@@ -69,7 +69,7 @@ public class Spline implements Savable {
      *
      * @param splineType the type of the spline @see {SplineType}
      * @param controlPoints an array of vector to use as control points of the spline
-     * If the type of the curve is Bezier curve the control points should be provided
+     * If the type of the curve is Bézier curve the control points should be provided
      * in the appropriate way. Each point 'p' describing control position in the scene
      * should be surrounded by two handler points. This applies to every point except
      * for the border points of the curve, who should have only one handle point.
@@ -99,7 +99,7 @@ public class Spline implements Savable {
      *
      * @param splineType the type of the spline @see {SplineType}
      * @param controlPoints a list of vector to use as control points of the spline
-     * If the curve is a Bezier curve, the control points should be provided
+     * If the curve is a Bézier curve, the control points should be provided
      * in the appropriate way. Each point 'p' describing control position in the scene
      * should be surrounded by two handler points. This applies to every point except
      * for the border points of the curve, who should have only one handle point.
@@ -256,7 +256,7 @@ public class Spline implements Savable {
     }
 
     /**
-     * This method calculates the Bezier curve length.
+     * This method calculates the Bézier curve length.
      */
     private void computeBezierLength() {
         float l = 0;

+ 1 - 1
jme3-core/src/main/java/com/jme3/opencl/Program.java

@@ -93,7 +93,7 @@ public abstract class Program extends AbstractOpenCLObject {
 
     /**
      * Creates all available kernels in this program.
-     * The names of the kernels can then by queried by {@link Kernel#getName() }.
+     * The names of the kernels can then be queried by {@link Kernel#getName() }.
      *
      * @return an array of all kernels
      */

+ 5 - 5
jme3-core/src/main/java/com/jme3/opencl/package-info.java

@@ -75,9 +75,9 @@
  * the argument. A buffer on its own is typeless. In the kernel, you then specify
  * the type of the buffer by argument declarations like {@code __global float* buffer}.
  * Note that OpenCL does not check buffer boundaries. If you read or write outside
- * of the buffer, the behavior is completely undefined and may often result in
+ * the buffer, the behavior is completely undefined and may often result in
  * a program cache later on.
- * {@link com.jme3.opencl.Image} objects are structured one, two or three dimensional
+ * {@link com.jme3.opencl.Image} objects are structured one-, two-, or three-dimensional
  * memory chunks of a fixed type. They are created by Context.createImage().
  * They need special functions in the kernel code to write to or read from images.
  * Both buffer and image objects provide methods for copying between buffers and images,
@@ -92,7 +92,7 @@
  * <br>
  * Some methods have the suffix {@code -NoEvent}. This means that these methods
  * don't return an event object even if the OpenCL function would return an event.
- * There exists always an alternative version that does return an event.
+ * There's always an alternative version that does return an event.
  * These methods exist to increase the performance: since all actions (like multiple kernel calls)
  * that are sent to the same command queue are executed in order, there is no
  * need for intermediate events. (These intermediate events would be released
@@ -102,7 +102,7 @@
  * 
  * <p>
  * <b>Interoperability between OpenCL and jME3:</b><br>
- * This Wrapper allows to share jME3 Images and VertexBuffers with OpenCL.<br>
+ * This Wrapper allows sharing jME3 Images and VertexBuffers with OpenCL.<br>
  * {@link com.jme3.scene.VertexBuffer} objects can be shared with OpenCL
  * by calling {@link com.jme3.opencl.Context#bindVertexBuffer(com.jme3.scene.VertexBuffer, com.jme3.opencl.MemoryAccess) }
  * resulting in a {@link com.jme3.opencl.Buffer} object. This buffer object
@@ -112,7 +112,7 @@
  * or variations of this method. The same holds for {@link com.jme3.texture.FrameBuffer.RenderBuffer} objects
  * using {@link com.jme3.opencl.Context#bindRenderBuffer(com.jme3.texture.FrameBuffer.RenderBuffer, com.jme3.opencl.MemoryAccess) }.
  * These methods result in an OpenCL-Image. Usages are e.g. animated textures,
- * terrain based on height maps, post processing effects and so forth.
+ * terrain based on height maps, post-processing effects, and so forth.
  * <br>
  * <i>Important:</i> Before shared objects can be used by any OpenCL function
  * like kernel calls or read/write/copy methods, they must be acquired explicitly

+ 9 - 10
jme3-core/src/main/java/com/jme3/renderer/RenderManager.java

@@ -517,7 +517,7 @@ public class RenderManager {
      * True if the translucent bucket should automatically be rendered
      * by the RenderManager.
      *
-     * @return Whether or not the translucent bucket is rendered.
+     * @return true if the translucent bucket is rendered
      *
      * @see #setHandleTranslucentBucket(boolean)
      */
@@ -530,8 +530,7 @@ public class RenderManager {
      * {@link Bucket#Translucent translucent bucket}
      * by the RenderManager. The default is enabled.
      *
-     * @param handleTranslucentBucket Whether or not the translucent bucket should
-     *     be rendered.
+     * @param handleTranslucentBucket true to render the translucent bucket
      */
     public void setHandleTranslucentBucket(boolean handleTranslucentBucket) {
         this.handleTranslucentBucket = handleTranslucentBucket;
@@ -610,9 +609,9 @@ public class RenderManager {
 
         Material material = geom.getMaterial();
 
-        //if forcedTechnique we try to force it for render,
-        //if it does not exists in the mat def, we check for forcedMaterial and render the geom if not null
-        //else the geom is not rendered
+        // If forcedTechnique exists, we try to force it for the render.
+        // If it does not exist in the mat def, we check for forcedMaterial and render the geom if not null.
+        // Otherwise, the geometry is not rendered.
         if (forcedTechnique != null) {
             MaterialDef matDef = material.getMaterialDef();
             if (matDef.getTechniqueDefs(forcedTechnique) != null) {
@@ -639,8 +638,8 @@ public class RenderManager {
                 forcedRenderState = tmpRs;
 
                 //Reverted this part from revision 6197
-                //If forcedTechnique does not exists, and forcedMaterial is not set,
-                //the geom MUST NOT be rendered
+                // If forcedTechnique does not exist and forcedMaterial is not set,
+                // the geometry MUST NOT be rendered.
             } else if (forcedMaterial != null) {
                 // use forced material
                 forcedMaterial.render(geom, lightList, this);
@@ -811,7 +810,7 @@ public class RenderManager {
     /**
      * Flushes the ViewPort's {@link ViewPort#getQueue() render queue}
      * by rendering each of its visible buckets.
-     * By default the queues will automatically be cleared after rendering,
+     * By default, the queues will be cleared automatically after rendering,
      * so there's no need to clear them manually.
      *
      * @param vp The ViewPort of which the queue will be flushed
@@ -905,7 +904,7 @@ public class RenderManager {
      * on the queue. Makes sure to restore the depth range to [0, 1]
      * at the end of the call.
      * Note that the {@link Bucket#Translucent translucent bucket} is NOT
-     * rendered by this method. Instead the user should call
+     * rendered by this method. Instead, the user should call
      * {@link #renderTranslucentQueue(com.jme3.renderer.ViewPort) }
      * after this call.
      *

+ 4 - 4
jme3-core/src/main/java/com/jme3/renderer/Renderer.java

@@ -346,7 +346,7 @@ public interface Renderer {
      * Resets all previously used {@link NativeObject Native Objects} on this Renderer.
      * The state of the native objects is reset in such way, that using
      * them again will cause the renderer to reupload them.
-     * Call this method when you know the GL context is going to shutdown.
+     * Call this method when you know the GL context is going to shut down.
      *
      * @see NativeObject#resetObject()
      */
@@ -366,7 +366,7 @@ public interface Renderer {
      *
      * <p>If the
      * {@link Texture#setAnisotropicFilter(int) texture anisotropic filter} is
-     * set to 0, then the default level is used. Otherwise if the texture level
+     * set to 0, then the default level is used. Otherwise, if the texture level
      * is 1 or greater, then the texture's value overrides the default value.
      *
      * @param level The default anisotropic filter level to use. Default: 1.
@@ -463,7 +463,7 @@ public interface Renderer {
     public void stopProfiling();
 
     /**
-     * Returns the time in nano seconds elapsed for the task with the given id.
+     * Returns the time in nanoseconds elapsed for the task with the given id.
      * Note that the result may not be available right after stopProfiling has been called.
      * You need to check if the result is available with isTaskResultAvailable.
      * Also note that it's guaranteed that the result will be available on next frame.
@@ -471,7 +471,7 @@ public interface Renderer {
      * you don't need to check the result availability with isTaskResultAvailable
      *
      * @param taskId the id of the task given by startProfiling.
-     * @return the time in nano second of the profiling task with the given id.
+     * @return the time in nanosecond of the profiling task with the given id.
      */
     public long getProfilingTime(int taskId);
 

+ 5 - 5
jme3-core/src/main/java/com/jme3/scene/Node.java

@@ -477,7 +477,7 @@ public class Node extends Spatial {
     }
 
     /**
-     * More efficient than e.g detaching and attaching as no updates are needed.
+     * More efficient than e.g. detaching and attaching, as no updates are needed.
      *
      * @param index1 The index of the first child to swap
      * @param index2 The index of the second child to swap
@@ -502,7 +502,7 @@ public class Node extends Spatial {
 
     /**
      * <code>getChild</code> returns the first child found with exactly the
-     * given name (case sensitive.) This method does a depth first recursive
+     * given name (case-sensitive). This method does a depth-first recursive
      * search of all descendants of this node, it will return the first spatial
      * found with a matching name.
      *
@@ -584,7 +584,7 @@ public class Node extends Spatial {
         // The idea is when there are few children,
         // it can be too expensive to test boundingVolume first.
         /*
-        I'm removing this change until some issues can be addressed and I really
+        I'm removing this change until some issues can be addressed, and I really
         think it needs to be implemented a better way anyway.
         First, it causes issues for anyone doing collideWith() with BoundingVolumes
         and expecting it to trickle down to the children.  For example, children
@@ -600,10 +600,10 @@ public class Node extends Spatial {
         all of that calculation.  For example, if 'other' is also a BoundingVolume (ie: 99.9%
         of all non-Ray cases) then a direct BV to BV intersects() test can be done.  So much
         faster.  And if 'other' _is_ a Ray then the BV.intersects(Ray) call can be done.
-        I don't have time to do it right now but I'll at least un-break a bunch of peoples'
+        I don't have time to do it right now, but I'll at least un-break a bunch of people's
         code until it can be 'optimized' properly.  Hopefully it's not too late to back out
         the other dodgy ripples this caused.  -pspeed (hindsight-expert ;))
-        Note: the code itself is relatively simple to implement but I don't have time to
+        Note: the code itself is relatively simple to implement, but I don't have time to
         a) test it, and b) see if '> 4' is still a decent check for it.  Could be it's fast
         enough to do all the time for > 1.
         if (children.size() > 4)

+ 24 - 24
jme3-core/src/main/java/com/jme3/scene/Spatial.java

@@ -193,8 +193,8 @@ public abstract class Spatial implements Savable, Cloneable, Collidable,
     }
 
     /**
-     * Constructor instantiates a new <code>Spatial</code> object setting the
-     * rotation, translation and scale value to defaults.
+     * Constructor instantiates a new <code>Spatial</code> object, setting the
+     * rotation, translation, and scale values to their defaults.
      *
      * @param name
      *            the name of the scene element. This is required for
@@ -259,9 +259,9 @@ public abstract class Spatial implements Savable, Cloneable, Collidable,
         // override (which would be more correct) is because the flag provides
         // some flexibility in how we break subclasses.  A protected method
         // would require that all subclasses that required updates need implement
-        // this method or they would silently stop processing updates.  A flag
+        // this method, or they would silently stop processing updates.  A flag
         // lets us set a default when a subclass is detected that is different
-        // than the internal "more efficient" default.
+        // from the internal "more efficient" default.
         // Spatial's default is 'true' for this flag requiring subclasses to
         // override it for more optimal behavior.  Node and Geometry will override
         // it to false if the class is Node.class or Geometry.class.
@@ -776,8 +776,8 @@ public abstract class Spatial implements Savable, Cloneable, Collidable,
         controls.add(control);
         control.setSpatial(this);
         boolean after = requiresUpdates();
-        // If the requirement to be updated has changed
-        // then we need to let the parent node know so it
+        // If the requirement to be updated has changed,
+        // then we need to let the parent node know, so it
         // can rebuild its update list.
         if (parent != null && before != after) {
             parent.invalidateUpdateList();
@@ -800,8 +800,8 @@ public abstract class Spatial implements Savable, Cloneable, Collidable,
             }
         }
         boolean after = requiresUpdates();
-        // If the requirement to be updated has changed
-        // then we need to let the parent node know so it
+        // If the requirement to be updated has changed,
+        // then we need to let the parent node know, so it
         // can rebuild its update list.
         if (parent != null && before != after) {
             parent.invalidateUpdateList();
@@ -825,8 +825,8 @@ public abstract class Spatial implements Savable, Cloneable, Collidable,
         }
 
         boolean after = requiresUpdates();
-        // If the requirement to be updated has changed
-        // then we need to let the parent node know so it
+        // If the requirement to be updated has changed,
+        // then we need to let the parent node know, so it
         // can rebuild its update list.
         if (parent != null && before != after) {
             parent.invalidateUpdateList();
@@ -891,7 +891,7 @@ public abstract class Spatial implements Savable, Cloneable, Collidable,
     }
 
     /**
-     * <code>updateGeometricState</code> updates the lightlist,
+     * <code>updateGeometricState</code> updates the light list,
      * computes the world transforms, and computes the world bounds
      * for this Spatial.
      * Calling this when the Spatial is attached to a node
@@ -1295,10 +1295,10 @@ public abstract class Spatial implements Savable, Cloneable, Collidable,
     }
 
     /**
-     * Returns this spatial's renderqueue bucket. If the mode is set to inherit,
-     * then the spatial gets its renderqueue bucket from its parent.
+     * Returns this spatial's render-queue bucket. If the mode is set to inherit,
+     * then the spatial gets its render-queue bucket from its parent.
      *
-     * @return The spatial's current renderqueue mode.
+     * @return The spatial's current render-queue bucket.
      */
     public RenderQueue.Bucket getQueueBucket() {
         if (queueBucket != RenderQueue.Bucket.Inherit) {
@@ -1371,7 +1371,7 @@ public abstract class Spatial implements Savable, Cloneable, Collidable,
      * @see Mesh#cloneForAnim()
      */
     public Spatial clone(boolean cloneMaterial) {
-        // Setup the cloner for the type of cloning we want to do.
+        // Set up the cloner for the type of cloning we want to do.
         Cloner cloner = new Cloner();
 
         // First, we definitely do not want to clone our own parent
@@ -1383,9 +1383,9 @@ public abstract class Spatial implements Savable, Cloneable, Collidable,
             cloner.setCloneFunction(Material.class, new IdentityCloneFunction<Material>());
         }
 
-        // By default the meshes are not cloned.  The geometry
-        // may choose to selectively force them to be cloned but
-        // normally they will be shared
+        // By default, the meshes are not cloned.  The geometry
+        // may choose to selectively force them to be cloned, but
+        // normally they will be shared.
         cloner.setCloneFunction(Mesh.class, new IdentityCloneFunction<Mesh>());
 
         // Clone it!
@@ -1433,7 +1433,7 @@ public abstract class Spatial implements Savable, Cloneable, Collidable,
      * @see Spatial#clone()
      */
     public Spatial deepClone() {
-        // Setup the cloner for the type of cloning we want to do.
+        // Set up the cloner for the type of cloning we want to do.
         Cloner cloner = new Cloner();
 
         // First, we definitely do not want to clone our own parent
@@ -1621,8 +1621,8 @@ public abstract class Spatial implements Savable, Cloneable, Collidable,
         //changed for backward compatibility with j3o files
         //generated before the AnimControl/SkeletonControl split
         //the AnimControl creates the SkeletonControl for old files and add it to the spatial.
-        //The SkeletonControl must be the last in the stack
-        //so we add the list of all other control before it.
+        // The SkeletonControl must be the last in the stack,
+        // so we add the list of all other controls before it.
         //When backward compatibility won't be needed anymore this can be replaced by :
         //controls = ic.readSavableArrayList("controlsList", null));
         controls.addAll(0, ic.readSavableArrayList("controlsList", null));
@@ -1670,14 +1670,14 @@ public abstract class Spatial implements Savable, Cloneable, Collidable,
     }
 
     /**
-     * @return the cullmode set on this Spatial
+     * @return the cull mode of this Spatial
      */
     public CullHint getLocalCullHint() {
         return cullHint;
     }
 
     /**
-     * @return the batchHint set on this Spatial
+     * @return the batch hint for this Spatial
      */
     public BatchHint getLocalBatchHint() {
         return batchHint;
@@ -1754,7 +1754,7 @@ public abstract class Spatial implements Savable, Cloneable, Collidable,
 
     /**
      * Returns the Spatial's name followed by the class of the spatial <br>
-     * Example: "MyNode (com.jme3.scene.Spatial)
+     * Example: "MyNode (com.jme3.scene.Spatial)"
      *
      * @return Spatial's name followed by the class of the Spatial
      */

+ 1 - 1
jme3-core/src/main/java/com/jme3/scene/package.html

@@ -18,7 +18,7 @@ in jMonkeyEngine.
     the "branches" in the graph, used to organize elements in a tree
     hierarchy. The {@link com.jme3.scene.Geometry} is the leaf class that
     will contain a {@link com.jme3.scene.Mesh} object (geometry data
-    such as vertex positions, normals, etc) and a {@link com.jme3.material.Material}
+    such as vertex positions, normals, etc.) and a {@link com.jme3.material.Material}
     object containing information on how the geometry should be shaded.
 </p>
 

+ 2 - 2
jme3-core/src/main/java/com/jme3/scene/shape/Surface.java

@@ -68,7 +68,7 @@ public class Surface extends Mesh {
      * @param vSegments the amount of V segments
      * @param basisUFunctionDegree the degree of basis U function
      * @param basisVFunctionDegree the degree of basis V function
-     * @param smooth defines if the mesu should be smooth (true) or flat (false)
+     * @param smooth defines if the mesh should be smooth (true) or flat (false)
      */
     private Surface(List<List<Vector4f>> controlPoints, List<Float>[] nurbKnots, int uSegments, int vSegments, int basisUFunctionDegree, int basisVFunctionDegree, boolean smooth) {
         this.validateInputData(controlPoints, nurbKnots, uSegments, vSegments);
@@ -127,7 +127,7 @@ public class Surface extends Mesh {
     /**
      * This method creates the surface.
      * @param smooth
-     *            defines if the mesu should be smooth (true) or flat (false)
+     *            defines if the mesh should be smooth (true) or flat (false)
      */
     private void buildSurface(boolean smooth) {
         float minUKnot = this.getMinUNurbKnot();

+ 5 - 5
jme3-core/src/main/java/com/jme3/shader/Shader.java

@@ -75,25 +75,25 @@ public final class Shader extends NativeObject {
     public static enum ShaderType {
 
         /**
-         * Control fragment rasterization. (e.g color of pixel).
+         * Control fragment rasterization. (e.g. color of pixel).
          */
         Fragment("frag"),
         /**
-         * Control vertex processing. (e.g transform of model to clip space)
+         * Control vertex processing. (e.g. transform of model to clip space)
          */
         Vertex("vert"),
         /**
-         * Control geometry assembly. (e.g compile a triangle list from input
+         * Control geometry assembly. (e.g. compile a triangle list from input
          * data)
          */
         Geometry("geom"),
         /**
-         * Controls tessellation factor (e.g how often an input patch should be
+         * Controls tessellation factor (e.g. how often an input patch should be
          * subdivided)
          */
         TessellationControl("tsctrl"),
         /**
-         * Controls tessellation transform (e.g similar to the vertex shader, but
+         * Controls tessellation transform (e.g. similar to the vertex shader, but
          * required to mix inputs manual)
          */
         TessellationEvaluation("tseval");

+ 7 - 7
jme3-core/src/main/java/com/jme3/shader/ShaderGenerator.java

@@ -280,7 +280,7 @@ public abstract class ShaderGenerator {
     /**
      * generates the varyings for the given shader type shader. Note that
      * varyings are deprecated in glsl 1.3, but this method will still be called
-     * to generate all non global inputs and output of the shaders.
+     * to generate all non-global inputs and output of the shaders.
      *
      * @param source the source StringBuilder to append generated code.
      * @param info the ShaderGenerationInfo.
@@ -315,9 +315,9 @@ public abstract class ShaderGenerator {
     protected abstract void generateStartOfMainSection(StringBuilder source, ShaderGenerationInfo info, ShaderType type);
 
     /**
-     * generates the end of the shader main section. this method is responsible
-     * of appending the last "}" in the shader and mapping all global outputs of
-     * the shader
+     * Generates the end of the shader main section. This method is responsible
+     * for appending the last "}" in the shader and mapping all global outputs of
+     * the shader.
      *
      * @param source the StringBuilder to append generated code.
      * @param info the ShaderGenerationInfo.
@@ -341,9 +341,9 @@ public abstract class ShaderGenerator {
     protected abstract void generateNodeMainSection(StringBuilder source, ShaderNode shaderNode, String nodeSource, ShaderGenerationInfo info);
 
     /**
-     * returns the shaderpath index according to the version of the generator.
-     * This allow to select the higher version of the shader that the generator
-     * can handle
+     * Returns the shader-path index according to the version of the generator.
+     * This allows selecting the highest version of the shader that the generator
+     * can handle.
      *
      * @param shaderNode the shaderNode being processed
      * @param type the shaderType

+ 1 - 1
jme3-core/src/main/java/com/jme3/shader/ShaderNode.java

@@ -39,7 +39,7 @@ import java.util.List;
 
 /**
  * A ShaderNode is the unit brick part of a shader program. A shader can be
- * describe with several shader nodes that are plugged together through inputs
+ * described by several shader nodes that are plugged together through inputs
  * and outputs.
  *
  * A ShaderNode is based on a definition that has a shader code, inputs and

+ 1 - 1
jme3-core/src/main/java/com/jme3/shader/ShaderVariable.java

@@ -43,7 +43,7 @@ public class ShaderVariable {
 
     /**
      * Name of the uniform as was declared in the shader.
-     * E.g name = "g_WorldMatrix" if the declaration was
+     * E.g. name = "g_WorldMatrix" if the declaration was
      * "uniform mat4 g_WorldMatrix;".
      */
     protected String name = null;

+ 1 - 1
jme3-core/src/main/java/com/jme3/shadow/PssmShadowFilter.java

@@ -80,7 +80,7 @@ public class PssmShadowFilter extends Filter {
     }
     
     /**
-     * Creates a PSSM Shadow Filter 
+     * Creates a PSSM Shadow Filter.
      * More info on the technique at <a href="http://http.developer.nvidia.com/GPUGems3/gpugems3_ch10.html">http://http.developer.nvidia.com/GPUGems3/gpugems3_ch10.html</a>
      * @param manager the application asset manager
      * @param size the size of the rendered shadowmaps (512,1024,2048, etc...)

+ 1 - 1
jme3-core/src/main/java/com/jme3/shadow/PssmShadowUtil.java

@@ -74,7 +74,7 @@ public final class PssmShadowUtil {
             splits[i] = log * lambda + uniform * (1.0f - lambda);
         }
 
-        // This is used to improve the correctness of the calculations. Our main near- and farplane
+        // This is used to improve the correctness of the calculations. The near and far planes
         // of the camera always stay the same, no matter what happens.
         splits[0] = near;
         splits[splits.length - 1] = far;

+ 1 - 1
jme3-core/src/main/java/com/jme3/shadow/ShadowUtil.java

@@ -285,7 +285,7 @@ public class ShadowUtil {
         vars.release();
         Vector3f center = min.add(max).multLocal(0.5f);
         Vector3f extent = max.subtract(min).multLocal(0.5f);
-        //Nehon 08/18/2010 : Added an offset to the extend to avoid banding artifacts when the frustum are aligned
+        //Nehon 08/18/2010 : Added an offset to the extend, to avoid banding artifacts when the frustums are aligned.
         return new BoundingBox(center, extent.x + 2.0f, extent.y + 2.0f, extent.z + 2.5f);
     }
 

+ 2 - 2
jme3-core/src/main/java/com/jme3/ui/Picture.java

@@ -56,7 +56,7 @@ public class Picture extends Geometry {
     /**
      * Create a named picture. 
      * 
-     * By default a picture's width and height are 1
+     * By default, a picture's width and height are 1,
      * and its position is 0, 0.
      * 
      * @param name the name of the picture in the scene graph
@@ -70,7 +70,7 @@ public class Picture extends Geometry {
 
     /**
      * Creates a named picture.
-     * By default a picture's width and height are 1
+     * By default, a picture's width and height are 1,
      * and its position is 0, 0.
      * The image texture coordinates will not be flipped.
      * 

+ 3 - 3
jme3-core/src/main/java/com/jme3/util/SafeArrayList.java

@@ -378,7 +378,7 @@ public class SafeArrayList<E> implements List<E>, Cloneable {
     @Override
     public List<E> subList(int fromIndex, int toIndex) {
 
-        // So far JME doesn't use subList that I can see so I'm nerfing it.
+        // So far, JME doesn't use subList that I can see, so I'm nerfing it.
         List<E> raw =  Arrays.asList(getArray()).subList(fromIndex, toIndex);
         return Collections.unmodifiableList(raw);
     }
@@ -452,9 +452,9 @@ public class SafeArrayList<E> implements List<E>, Cloneable {
 
         @Override
         public void remove() {
-            // This operation is not so easy to do but we will fake it.
+            // This operation is not so easy to do, but we will fake it.
             // The issue is that the backing list could be completely
-            // different than the one this iterator is a snapshot of.
+            // different from the one this iterator is a snapshot of.
             // We'll just remove(element) which in most cases will be
             // correct.  If the list had earlier .equals() equivalent
             // elements then we'll remove one of those instead.  Either

+ 1 - 1
jme3-core/src/main/java/com/jme3/util/TangentBinormalGenerator.java

@@ -268,7 +268,7 @@ public class TangentBinormalGenerator {
         return vertices;
     }
 
-    //Don't remove split mirrored boolean. It's not used right now, but I intend to
+    // Don't remove the split mirrored boolean. It's not used right now, but I intend to
     // make this method also split vertices with rotated tangent space, and I'll
     // add another splitRotated boolean.
     private static List<VertexData> splitVertices(Mesh mesh, List<VertexData> vertexData, boolean splitMirorred) {

+ 0 - 1
jme3-core/src/main/java/com/jme3/util/xml/SAXUtil.java

@@ -110,7 +110,6 @@ public final class SAXUtil {
         else
             return Boolean.valueOf(bool); 
         //else
-        //else
         //    throw new SAXException("Expected a boolean, got'"+bool+"'");
     }
 

+ 5 - 5
jme3-core/src/plugins/java/com/jme3/material/plugins/ShaderNodeLoaderDelegate.java

@@ -49,9 +49,9 @@ import java.util.*;
  * This class is here to be able to load shaderNodeDefinition from both the
  * J3MLoader and ShaderNodeDefinitionLoader.
  *
- * Also it allows to load the ShaderNodes from a j3md file and build the
+ * It also allows loading shader nodes from a j3md file and building the
  * ShaderNodes list of each technique and the ShaderGenerationInfo needed to
- * generate shaders
+ * generate shaders.
  *
  * @author Nehon
  */
@@ -132,7 +132,7 @@ public class ShaderNodeLoaderDelegate {
      * ShaderNodesDefinition This method is used by the j3m loader.
      *
      * When loaded in a material, the definitions are not stored as a list, but
-     * they are stores in Shadernodes based on this definition.
+     * they are stored in shader nodes based on this definition.
      *
      * The map is here to map the definition to the nodes, and ovoid reloading
      * already loaded definitions
@@ -1051,8 +1051,8 @@ public class ShaderNodeLoaderDelegate {
 
         declaredVar.addNode(shaderNode);
 
-        // if a variable is declared with the same name as an input and an output and is a varying,
-        // set it as a shader output so it's declared as a varying only once.
+        // If a variable is declared with the same name as an input and an output and is a varying,
+        // set it as a shader output, so it's declared as a varying only once.
         for (final VariableMapping variableMapping : node.getInputMapping()) {
             final ShaderNodeVariable leftVariable = variableMapping.getLeftVariable();
             if (leftVariable.getName().equals(variable.getName())) {

+ 1 - 1
jme3-core/src/test/java/com/jme3/scene/PhantomTrianglesTest.java

@@ -46,7 +46,7 @@ import com.jme3.system.MockJmeSystemDelegate;
 import org.junit.Test;
 
 /**
- * Verify that collideWith() doesn't reports collisions with phantom triangles.
+ * Verify that collideWith() doesn't report collisions with phantom triangles.
  * This was issue #710 at GitHub.
  *
  * @author Stephen Gold

+ 1 - 1
jme3-desktop/src/main/java/com/jme3/app/SettingsDialog.java

@@ -51,7 +51,7 @@ import javax.swing.*;
 
 /**
  * <code>SettingsDialog</code> displays a Swing dialog box to interactively
- * configure the <code>AppSettings</code> of a desktop application betore
+ * configure the <code>AppSettings</code> of a desktop application before
  * <code>start()</code> is invoked.
  *
  * The <code>AppSettings</code> instance to be configured is passed to the

+ 4 - 4
jme3-desktop/src/main/java/com/jme3/system/NativeLibraryLoader.java

@@ -202,7 +202,7 @@ public final class NativeLibraryLoader {
     }
     
     /**
-     * Determine if native bullet is on the classpath.
+     * Determines whether native Bullet is on the classpath.
      * 
      * Currently the context extracts the native bullet libraries, so
      * this method is needed to determine if it is needed.
@@ -572,7 +572,7 @@ public final class NativeLibraryLoader {
             // Attempt to load it as a system library.
             String unmappedName = unmapLibraryName(fileNameInJar);
             try {
-                // XXX: HACK. Vary loading method based on library name..
+                // XXX: HACK. Vary loading method based on library name.
                 // lwjgl and jinput handle loading by themselves.
                 if (!name.equals("lwjgl") && !name.equals("jinput")) {
                     // Need to unmap it from library specific parts.
@@ -615,7 +615,7 @@ public final class NativeLibraryLoader {
             conn = url.openConnection();
             in = conn.getInputStream();
         } catch (IOException ex) {
-            // Maybe put more detail here? Not sure..
+            // Maybe put more detail here? Not sure.
             throw new UncheckedIOException("Failed to open file: '" + url + 
                                            "'. Error: " + ex, ex);
         }
@@ -661,7 +661,7 @@ public final class NativeLibraryLoader {
                         + "library to: " + targetFile, ex);
             }
         } finally {
-            // XXX: HACK. Vary loading method based on library name..
+            // XXX: HACK. Vary loading method based on library name.
             // lwjgl and jinput handle loading by themselves.
             if (name.equals("lwjgl") || name.equals("lwjgl3")) {
                 System.setProperty("org.lwjgl.librarypath", 

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

@@ -285,7 +285,7 @@ public class SSAOFilter extends Filter {
 
     /**
      * debugging only , will be removed
-     * @return Whether or not
+     * @return true if using ambient occlusion
      */
     public boolean isUseAo() {
         return useAo;

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

@@ -51,8 +51,8 @@ import com.jme3.ui.Picture;
  *
  * Simple Water renders a simple plane that use reflection and refraction to look like water.
  * It's pretty basic, but much faster than the WaterFilter
- * It's useful if you aim for low specs hardware and still want a good looking water.
- * Usage is :
+ * It's useful if you aim for low specs hardware and still want good-looking water.
+ * Usage is:
  * <code>
  *      SimpleWaterProcessor waterProcessor = new SimpleWaterProcessor(assetManager);
  *      //setting the scene to use for reflection

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

@@ -212,7 +212,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
     }
 
     /**
-     * @return true if need to try to use direction light from a scene.
+     * @return true to try using directional light from a scene
      */
     protected boolean useDirectionLightFromScene() {
         return true;

+ 0 - 1
jme3-examples/src/main/java/jme3test/batching/TestBatchNodeCluster.java

@@ -87,7 +87,6 @@ public class TestBatchNodeCluster extends SimpleApplication {
     private Material mat3;
     private Material mat4;
     private Node terrain;
-    //protected
 //    protected Geometry player;
 
     @Override

+ 2 - 2
jme3-examples/src/main/java/jme3test/games/WorldOfInception.java

@@ -244,7 +244,7 @@ public class WorldOfInception extends SimpleApplication implements AnalogListene
             }
 
             AppStateManager stateManager = application.getStateManager();
-            // We create child positions based on the parent position hash so we
+            // We create child positions based on the parent position hash, so we
             // should in practice get the same galaxy w/o too many doubles
             // with each run with the same root vector.
             Vector3f[] vectors = getPositions(poiCount, inParentPosition.hashCode());
@@ -276,7 +276,7 @@ public class WorldOfInception extends SimpleApplication implements AnalogListene
                     currentReturnLevel = this;
                     return;
                 } else if (currentActiveChild != null && currentActiveChild.getPositionInParent().equals(vector3f)) {
-                    //TODO: doing this here causes problems when close to multiple pois
+                    //TODO: doing this here causes problems when close to multiple POIs
                     rootNode.getChild(i).setCullHint(Spatial.CullHint.Inherit);
                 }
             }

+ 1 - 1
jme3-examples/src/main/java/jme3test/network/TestLatency.java

@@ -91,7 +91,7 @@ public class TestLatency {
                 long latency = (curTime - timeMsg.timeSent);
                 System.out.println("Latency: " + (latency) + " ms");
                 //long timeOffset = ((timeMsg.timeSent + curTime) / 2) - timeMsg.timeReceived;
-                //System.out.println("Approximate timeoffset: "+ (timeOffset) + " ms");
+                //System.out.println("Approximate timeOffset: "+ (timeOffset) + " ms");
 
                 average.add(latency);
                 System.out.println("Average latency: " + average.getAverage());

+ 3 - 3
jme3-examples/src/main/java/jme3test/post/TestPostFiltersCompositing.java

@@ -77,7 +77,7 @@ public class TestPostFiltersCompositing extends SimpleApplication {
         fpp.addFilter(new ColorOverlayFilter(ColorRGBA.Blue));
         viewPort.addProcessor(fpp);
 
-        //creating a frame buffer for the mainviewport
+        //creating a frame buffer for the main viewport
         FrameBuffer mainVPFrameBuffer = new FrameBuffer(cam.getWidth(), cam.getHeight(), 1);
         Texture2D mainVPTexture = new Texture2D(cam.getWidth(), cam.getHeight(), Image.Format.RGBA8);
         mainVPFrameBuffer.setDepthTarget(FrameBufferTarget.newTarget(Format.Depth));
@@ -95,8 +95,8 @@ public class TestPostFiltersCompositing extends SimpleApplication {
 
         guiViewPort.addProcessor(guifpp);
         
-        //compositing is done by mixing texture depending on the alpha channel, 
-        //it's important that the guiviewport clear color alpha value is set to 0
+        // Compositing is done by mixing texture depending on the alpha channel, so
+        // it's important that the GUI-viewport clear-color alpha value is set to 0.
         guiViewPort.setBackgroundColor(ColorRGBA.BlackNoAlpha);
         guiViewPort.setClearColor(true);
 

+ 1 - 1
jme3-examples/src/main/java/jme3test/renderer/TestBackgroundImage.java

@@ -116,7 +116,7 @@ public class TestBackgroundImage extends SimpleApplication {
     public void simpleUpdate(float timePerFrame) {
         /*
          * Since SimpleApplication is unaware of the background viewport,
-         * the application must explictly update its scenes.
+         * the application must explicitly update its scenes.
          */
         List<Spatial> scenes = backgroundViewport.getScenes();
         for (Spatial scene : scenes) {

+ 1 - 1
jme3-examples/src/main/java/jme3test/renderer/TestContextRestart.java

@@ -54,7 +54,7 @@ import com.jme3.system.AppSettings;
  * <p>
  * Note that for testing, it may be helpful to bypass the test chooser and run
  * this class directly, since it can be easier to define your own settings
- * beforehand. Of course, it should still workif all you need to test is the
+ * beforehand. Of course, it should still work if all you need to test is the
  * gamma correction, as long as you enable it in the settings dialog.
  * </p>
  *

+ 2 - 2
jme3-examples/src/main/java/jme3test/terrain/PBRTerrainAdvancedTest.java

@@ -99,7 +99,7 @@ import java.util.List;
  * jme3-testdata/src/main/resources/Textures/Terrain/PBR
  *
  * <p>
- * Notes: (as of 12 April, 2021)
+ * Notes: (as of 12 April 2021)
  * <ol>
  * <li>
  * The results look better with anti-aliasing, especially from a distance. This
@@ -163,7 +163,7 @@ public class PBRTerrainAdvancedTest extends SimpleApplication {
                     matTerrain.setBoolean("useTriPlanarMapping", true);
                     // Tri-planar textures don't use the mesh's texture coordinates but real world coordinates,
                     // so we need to convert these texture coordinate scales into real world scales so it looks
-                    // the same when we switch to/from tr-planar mode.
+                    // the same when we switch to/from tri-planar mode.
                     matTerrain.setFloat("AlbedoMap_0_scale", (dirtScale / terrainSize));
                     matTerrain.setFloat("AlbedoMap_1_scale", (darkRockScale / terrainSize));
                     matTerrain.setFloat("AlbedoMap_2_scale", (snowScale / terrainSize));

+ 2 - 2
jme3-examples/src/main/java/jme3test/terrain/PBRTerrainTest.java

@@ -77,7 +77,7 @@ import com.jme3.texture.Texture.WrapMode;
  * jme3-testdata/src/main/resources/Textures/Terrain/PBR
  *
  * <p>
- * Notes: (as of 12 April, 2021)
+ * Notes: (as of 12 April 2021)
  * <ol>
  * <li>
  * This shader is subject to the GLSL max limit of 16 textures, and users should
@@ -129,7 +129,7 @@ public class PBRTerrainTest extends SimpleApplication {
                     matTerrain.setBoolean("useTriPlanarMapping", true);
                     // Tri-planar textures don't use the mesh's texture coordinates but real world coordinates,
                     // so we need to convert these texture coordinate scales into real world scales so it looks
-                    // the same when we switch to/from tr-planar mode.
+                    // the same when we switch to/from tri-planar mode.
                     matTerrain.setFloat("AlbedoMap_0_scale", (dirtScale / terrainSize));
                     matTerrain.setFloat("AlbedoMap_1_scale", (darkRockScale / terrainSize));
                     matTerrain.setFloat("AlbedoMap_2_scale", (snowScale / terrainSize));

+ 1 - 1
jme3-examples/src/main/java/jme3test/terrain/TerrainTestAndroid.java

@@ -181,7 +181,7 @@ public class TerrainTestAndroid extends SimpleApplication {
                     matRock.setBoolean("useTriPlanarMapping", true);
                     // planar textures don't use the mesh's texture coordinates but real world coordinates,
                     // so we need to convert these texture coordinate scales into real world scales so it looks
-                    // the same when we switch to/from tr-planar mode
+                    // the same when we switch to/from tri-planar mode
                     matRock.setFloat("Tex1Scale", 1f / (512f / grassScale));
                     matRock.setFloat("Tex2Scale", 1f / (512f / dirtScale));
                     matRock.setFloat("Tex3Scale", 1f / (512f / rockScale));

+ 1 - 1
jme3-examples/src/main/java/jme3test/texture/TestTexture3D.java

@@ -66,7 +66,7 @@ public class TestTexture3D extends SimpleApplication {
         flyCam.setMoveSpeed(10);
         //creating a sphere
         Sphere sphere = new Sphere(32, 32, 1);
-        //getting the boundingbox
+        // getting the bounding box
         sphere.updateBound();
         BoundingBox bb = (BoundingBox) sphere.getBound();
         Vector3f min = bb.getMin(null);

+ 2 - 2
jme3-jbullet/src/main/java/com/jme3/bullet/PhysicsSpace.java

@@ -607,8 +607,8 @@ public class PhysicsSpace {
         physicsBodies.put(node.getObjectId(), node);
 
         //Workaround
-        //It seems that adding a Kinematic RigidBody to the dynamicWorld prevent it from being non kinematic again afterward.
-        //so we add it non kinematic, then set it kinematic again.
+        //It seems that adding a Kinematic RigidBody to the dynamicWorld prevent it from being non-kinematic again afterward.
+        //so we add it non-kinematic, then set it kinematic again.
         boolean kinematic = false;
         if (node.isKinematic()) {
             kinematic = true;

+ 3 - 3
jme3-jbullet/src/main/java/com/jme3/bullet/joints/SixDofJoint.java

@@ -50,9 +50,9 @@ import java.util.LinkedList;
 /**
  * <i>From bullet manual:</i><br>
  * This generic constraint can emulate a variety of standard constraints,
- * by configuring each of the 6 degrees of freedom (dof).
- * The first 3 dof axis are linear axis, which represent translation of rigidbodies,
- * and the latter 3 dof axis represent the angular motion. Each axis can be either locked,
+ * by configuring each of the 6 degrees of freedom (DOF).
+ * The first 3 DOF axes are linear axes, which represent translation of rigid bodies,
+ * and the latter 3 DOF axes represent the angular motion. Each axis can be either locked,
  * free or limited. On construction of a new btGeneric6DofConstraint, all axis are locked.
  * Afterwards the axis can be reconfigured. Note that several combinations that
  * include free and/or limited angular degrees of freedom are undefined.

+ 1 - 1
jme3-jbullet/src/main/java/com/jme3/bullet/objects/PhysicsCharacter.java

@@ -150,7 +150,7 @@ public class PhysicsCharacter extends PhysicsCollisionObject {
         return jumpSpeed;
     }
 
-    //does nothing..
+    //does nothing
 //    public void setMaxJumpHeight(float height) {
 //        character.setMaxJumpHeight(height);
 //    }

+ 2 - 2
jme3-jbullet/src/main/java/com/jme3/bullet/objects/PhysicsRigidBody.java

@@ -391,7 +391,7 @@ public class PhysicsRigidBody extends PhysicsCollisionObject {
     /**
      * Set the local gravity of this PhysicsRigidBody<br>
      * Set this after adding the node to the PhysicsSpace,
-     * the PhysicsSpace assigns its current gravity to the physics node when its added.
+     * the PhysicsSpace assigns its current gravity to the physics node when it's added.
      * @param gravity the gravity vector to set
      */
     public void setGravity(Vector3f gravity) {
@@ -440,7 +440,7 @@ public class PhysicsRigidBody extends PhysicsCollisionObject {
     }
 
     /**
-     * The "bounciness" of the PhysicsRigidBody, best performance if restitution=0
+     * The "bounciness" of the PhysicsRigidBody. Best performance with restitution=0.
      *
      * @param restitution the desired value (default=0)
      */

+ 4 - 4
jme3-jbullet/src/main/java/com/jme3/bullet/objects/PhysicsVehicle.java

@@ -214,8 +214,8 @@ public class PhysicsVehicle extends PhysicsRigidBody {
      * Use before adding wheels, this is the default used when adding wheels.
      * After adding the wheel, use direct wheel access.<br>
      * The coefficient of friction between the tyre and the ground.
-     * Should be about 0.8 for realistic cars, but can increased for better handling.
-     * Set large (10000.0) for kart racers
+     * Should be about 0.8 for realistic cars, but can be increased for better handling.
+     * Set large (10000.0) for kart racers.
      * @param frictionSlip the frictionSlip to set
      */
     public void setFrictionSlip(float frictionSlip) {
@@ -224,8 +224,8 @@ public class PhysicsVehicle extends PhysicsRigidBody {
 
     /**
      * The coefficient of friction between the tyre and the ground.
-     * Should be about 0.8 for realistic cars, but can increased for better handling.
-     * Set large (10000.0) for kart racers
+     * Should be about 0.8 for realistic cars, but can be increased for better handling.
+     * Set large (10000.0) for kart racers.
      *
      * @param wheel the index of the wheel to modify (&ge;0, &lt;count)
      * @param frictionSlip the desired coefficient of friction between tyre and

+ 2 - 2
jme3-jbullet/src/main/java/com/jme3/bullet/objects/infos/RigidBodyMotionState.java

@@ -67,7 +67,7 @@ public class RigidBodyMotionState extends MotionState {
     }
 
     /**
-     * called from bullet when creating the rigidbody
+     * Called from Bullet when creating the rigid body.
      * @param t caller-provided storage for the Transform
      * @return t
      */
@@ -78,7 +78,7 @@ public class RigidBodyMotionState extends MotionState {
     }
 
     /**
-     * called from bullet when the transform of the rigidbody changes
+     * Called from Bullet when the transform of the rigid body changes.
      *
      * @param worldTrans the new value (not null, unaffected)
      */

+ 2 - 2
jme3-jogg/src/main/java/com/jme3/audio/plugins/OGGLoader.java

@@ -174,7 +174,7 @@ public class OGGLoader implements AssetLoader {
      * of bytes in the input is returned.
      */
     private int getOggTotalBytes(int dataBytesTotal){
-        // Vorbis stream could have more samples than than the duration of the sound
+        // Vorbis stream could have more samples than the duration of the sound.
         // Must truncate.
         int numSamples;
         if (oggStream instanceof CachedOggStream){
@@ -311,7 +311,7 @@ public class OGGLoader implements AssetLoader {
             in = info.openStream();
             AudioData data = load(in, readStream, streamCache);
             if (readStream && !streamCache) {
-                // we still need the stream in this case ..
+                // We still need the stream in this case.
                 in = null;
             }
             return data;

+ 1 - 1
jme3-networking/src/main/java/com/jme3/network/Network.java

@@ -148,7 +148,7 @@ public class Network
     }
 
     /**
-     *  Creates a Client that communicates with the specified host and and separate TCP and UDP ports
+     *  Creates a Client that communicates with the specified host and separate TCP and UDP ports
      *  using both reliable and fast transports.  
      *  
      *  @param gameName This is the name that identifies the game.  This must match

+ 1 - 1
jme3-networking/src/main/java/com/jme3/network/NetworkClient.java

@@ -53,7 +53,7 @@ public interface NetworkClient extends Client
     /**
      *  Connects this client to the specified remote server and ports.
      *  
-     *  @param address  The hosts internet address.
+     *  @param address  The host's Internet address.
      *  @param port  The remote TCP port on the server to which this client should
      *                  send reliable messages. 
      *  @param remoteUdpPort  The remote UDP port on the server to which this client should

+ 1 - 1
jme3-networking/src/main/java/com/jme3/network/Server.java

@@ -100,7 +100,7 @@ public interface Server
     public void broadcast( int channel, Filter<? super HostedConnection> filter, Message message );
 
     /**
-     *  Start the server so that it will began accepting new connections
+     *  Start the server so that it will begin accepting new connections
      *  and processing messages.
      */
     public void start();

+ 6 - 6
jme3-networking/src/main/java/com/jme3/network/kernel/tcp/SelectorKernel.java

@@ -184,7 +184,7 @@ public class SelectorKernel extends AbstractKernel
     }
 
     /**
-     *  Used internally by the endpoints to wakeup the selector
+     *  Used internally by the endpoints to wake up the selector
      *  when they have data to send.
      */
     protected void wakeupSelector()
@@ -196,7 +196,7 @@ public class SelectorKernel extends AbstractKernel
     {
         // Note: if ever desirable, it would be possible to accumulate
         //       data per source channel and only 'finalize' it when
-        //       asked for more envelopes then were ready.  I just don't
+        //       asked for more envelopes than were ready.  I just don't
         //       think it will be an issue in practice.  The busier the
         //       server, the more the buffers will fill before we get to them.
         //       And if the server isn't busy, who cares if we chop things up
@@ -279,8 +279,8 @@ public class SelectorKernel extends AbstractKernel
             // For now, selection keys will either be in OP_READ
             // or OP_WRITE.  So while we are writing a buffer, we
             // will not be reading.  This is way simpler and less
-            // error prone... it can always be changed when everything
-            // else works if we are looking to micro-optimize.
+            // error-prone. It can be changed when everything
+            // else works, if we are looking to micro-optimize.
 
             // Setup options based on the current state of
             // the endpoints.  This could potentially be more
@@ -299,7 +299,7 @@ public class SelectorKernel extends AbstractKernel
             // Would only get accepts on a server channel
             ServerSocketChannel serverChan = (ServerSocketChannel)key.channel();
 
-            // Setup the connection to be non-blocking
+            // Set up the connection to be non-blocking.
             SocketChannel remoteChan = serverChan.accept();
             remoteChan.configureBlocking(false);
 
@@ -434,7 +434,7 @@ public class SelectorKernel extends AbstractKernel
                     reportError( e );
                     
                     // And at this level, errors likely mean the key is now
-                    // dead and it doesn't hurt to kick them anyway.  If we
+                    // dead, and it doesn't hurt to kick them anyway.  If we
                     // find IOExceptions that are not fatal, this can be
                     // readdressed
                     cancel( key, (SocketChannel)key.channel() );                    

+ 4 - 4
jme3-networking/src/main/java/com/jme3/network/message/SerializerRegistrationsMessage.java

@@ -47,9 +47,9 @@ import java.util.logging.Logger;
  *  Holds a compiled set of message registration information that
  *  can be sent over the wire.  The received message can then be
  *  used to register all of the classes using the same IDs and 
- *  same ordering, etc..  The intent is that the server compiles
+ *  same ordering, etcetera.  The intent is that the server compiles
  *  this message once it is sure that all serializable classes have
- *  been registered.  It can then send this to each new client and
+ *  been registered.  It can then send this to each new client, and
  *  they can use it to register all of the classes without requiring
  *  exactly reproducing the same calls that the server did to register
  *  messages.
@@ -69,7 +69,7 @@ public class SerializerRegistrationsMessage extends AbstractMessage {
 
     public static final Set<Class> ignore = new HashSet<Class>();
     static {
-        // We could build this automatically but then we
+        // We could build this automatically, but then we
         // risk making a client and server out of date simply because
         // their JME versions are out of date.
         ignore.add(Boolean.class);
@@ -168,7 +168,7 @@ public class SerializerRegistrationsMessage extends AbstractMessage {
             // assume that if the registry was compiled here then it means
             // we are also the server process.  Note that this wouldn't hold true
             // under complicated examples where there are clients of one server
-            // that also run their own servers but realistically they would have
+            // that also run their own servers, but realistically they would have
             // to disable the ServerSerializerRegistrationsServer anyway.
             if( compiled != null ) {
                 log.log(Level.INFO, "Skipping registration as registry is locked, presumably by a local server process.");

+ 1 - 1
jme3-networking/src/main/java/com/jme3/network/rmi/ObjectStore.java

@@ -72,7 +72,7 @@ public class ObjectStore {
     // Local invocation ID counter
     private volatile short invocationIdCounter = 0;
 
-    // Invocations waiting ..
+    // Invocations waiting
     private IntMap<Invocation> pendingInvocations = new IntMap<>();
     
     // Objects I share with other people

+ 2 - 2
jme3-networking/src/main/java/com/jme3/network/serializing/Serializer.java

@@ -225,8 +225,8 @@ public abstract class Serializer {
     }
     
     /**
-     *  Registers the specified class. The failOnMiss flag controls whether or
-     *  not this method returns null for failed registration or throws an exception.
+     *  Registers the specified class. The failOnMiss flag controls whether
+     *  this method returns null for failed registration or throws an exception.
      */
     @SuppressWarnings("unchecked")
     public static SerializerRegistration registerClass(Class cls, boolean failOnMiss) {

+ 2 - 2
jme3-networking/src/main/java/com/jme3/network/service/ServiceManager.java

@@ -39,7 +39,7 @@ import java.util.logging.Logger;
 
 /**
  *  The base service manager class from which the HostedServiceManager
- *  and ClientServiceManager classes are derived.  This manages the
+ *  and ClientServiceManager classes are derived.  This manages
  *  the underlying services and their life cycles.
  *
  *  @author    Paul Speed
@@ -157,7 +157,7 @@ public abstract class ServiceManager<T> {
  
     /**
      *  Terminates all services.  If the service manager has not been
-     *  stopped yet then it will be stopped.
+     *  stopped yet, then it will be stopped.
      */
     public void terminate() {
         if( started ) {

+ 6 - 6
jme3-networking/src/main/java/com/jme3/network/service/rmi/RmiHostedService.java

@@ -104,7 +104,7 @@ public class RmiHostedService extends AbstractHostedService {
     /**
      *  Shares a server-wide object associated with the specified type.  All connections
      *  with RMI hosting started will have access to this shared object as soon as they 
-     *  connect and they will all share the same instance.  It is up to the shared object 
+     *  connect, and they will all share the same instance.  It is up to the shared object
      *  to handle any multithreading that might be required.
      */     
     public <T> void shareGlobal( T object, Class<? super T> type ) {
@@ -114,7 +114,7 @@ public class RmiHostedService extends AbstractHostedService {
     /**
      *  Shares a server-wide object associated with the specified name.  All connections
      *  with RMI hosting started will have access to this shared object as soon as they 
-     *  connect and they will all share the same instance.  It is up to the shared object 
+     *  connect, and they will all share the same instance.  It is up to the shared object
      *  to handle any multithreading that might be required.
      */     
     public <T> void shareGlobal( String name, T object, Class<? super T> type ) {
@@ -124,7 +124,7 @@ public class RmiHostedService extends AbstractHostedService {
     /**
      *  Shares a server-wide object associated with the specified name over the specified
      *  channel.  All connections with RMI hosting started will have access to this shared 
-     *  object as soon as they connect and they will all share the same instance.  It is up 
+     *  object as soon as they connect, and they will all share the same instance.  It is up
      *  to the shared object to handle any multithreading that might be required.
      *  All network communication associated with the shared object will be done over
      *  the specified channel. 
@@ -133,7 +133,7 @@ public class RmiHostedService extends AbstractHostedService {
         GlobalShare share = new GlobalShare(channel, object, type);
         GlobalShare existing = globalShares.put(name, share);
         if( existing != null ) {
-            // Shouldn't need to do anything actually.
+            // Shouldn't need to do anything, actually.
         }
         
         // Go through all of the children
@@ -152,8 +152,8 @@ public class RmiHostedService extends AbstractHostedService {
      *  after some connection setup is done (for example, logging in).  Note: generally
      *  is safe to autohost RMI as long as callers are careful about what they've added
      *  using shareGlobal().  One reasonable use-case is to shareGlobal() some kind of login
-     *  service and nothing else.  All other shared objects would then be added as connection
-     *  specific objects during successful login processing. 
+     *  service and nothing else.  All other shared objects would then be added as
+     *  connection-specific objects during successful login processing.
      */
     public void setAutoHost( boolean b ) {
         this.autoHost = b;

+ 1 - 1
jme3-networking/src/main/java/com/jme3/network/service/rmi/RmiRegistry.java

@@ -162,7 +162,7 @@ public class RmiRegistry {
             local.byName.put(name, newShare);
             local.byId.put(newShare.objectId, newShare);
             
-            // Make sure we are setup to receive the remote method calls through
+            // Make sure we are set up to receive the remote method calls through
             // the RPC service
             rpc.registerHandler(newShare.objectId, rmiHandler);
             

+ 1 - 1
jme3-networking/src/main/java/com/jme3/network/service/rpc/RpcClientService.java

@@ -70,7 +70,7 @@ public class RpcClientService extends AbstractClientService {
     }
 
     /**
-     *  Used internally to setup the RpcConnection and MessageDelegator.
+     *  Used internally to set up the RpcConnection and MessageDelegator.
      */
     @Override
     @SuppressWarnings("unchecked")

+ 1 - 1
jme3-networking/src/main/java/com/jme3/network/service/rpc/RpcConnection.java

@@ -117,7 +117,7 @@ public class RpcConnection {
             log.log(Level.FINEST, "Sending:{0}  on channel:{1}", new Object[]{msg, channel});
         }
         
-        // Prevent non-async messages from being send as UDP
+        // Prevent non-async messages from being sent as UDP
         // because there is a high probability that this would block
         // forever waiting for a response.  For async calls it's ok
         // so it doesn't do the check.

+ 1 - 1
jme3-networking/src/main/java/com/jme3/network/service/rpc/RpcHostedService.java

@@ -94,7 +94,7 @@ public class RpcHostedService extends AbstractHostedConnectionService {
     }
 
     /**
-     *  Used internally to setup the message delegator that will
+     *  Used internally to set up the message delegator that will
      *  handle HostedConnection specific messages and forward them
      *  to that connection's RpcConnection.
      */

+ 2 - 2
jme3-niftygui/src/main/java/com/jme3/niftygui/NiftyJmeDisplay.java

@@ -196,7 +196,7 @@ public class NiftyJmeDisplay implements SceneProcessor {
       // additional parameter. This method should really be removed soon and
       // users should simply call the new factory methods.
       //
-      // For now I keep this constructor as-is but have marked it as deprecated
+      // For now, I keep this constructor as-is, but have marked it as deprecated
       // to allow migration to the new way to instantiate this class.
       initialize(assetManager, inputManager, audioRenderer, viewport);
 
@@ -243,7 +243,7 @@ public class NiftyJmeDisplay implements SceneProcessor {
     }
 
     /**
-     * Create a standard NiftyJmeDisplay. This uses the old Nifty renderer. It's probably slower then the batched
+     * Create a standard NiftyJmeDisplay. This uses the old Nifty renderer. It's probably slower than the batched
      * renderer and is mainly here for backwards compatibility.
      *
      * @param assetManager jME AssetManager

+ 1 - 1
jme3-niftygui/src/main/java/com/jme3/niftygui/SoundHandleJme.java

@@ -57,7 +57,7 @@ public class SoundHandleJme implements SoundHandle {
     }
 
     /**
-     * For streaming music only. (May need to loop..)
+     * For streaming music only. (May need to loop.)
      *
      * @param ar for rendering audio (not null)
      * @param am the AssetManager for loading assets (not null)

+ 2 - 2
jme3-plugins/src/ogre/java/com/jme3/scene/plugins/ogre/SceneLoader.java

@@ -423,7 +423,7 @@ public class SceneLoader extends DefaultHandler implements AssetLoader {
             if (elementStack.peek().equals("environment")) {
                 ColorRGBA color = parseColor(attribs);
                 if (!color.equals(ColorRGBA.Black) && !color.equals(ColorRGBA.BlackNoAlpha)) {
-                    // Lets add an ambient light to the scene.
+                    // Let's add an ambient light to the scene.
                     AmbientLight al = new AmbientLight();
                     al.setColor(color);
                     root.addLight(al);
@@ -454,7 +454,7 @@ public class SceneLoader extends DefaultHandler implements AssetLoader {
             node = cameraNode.getParent();
             cameraNode = null;
         } else if (qName.equals("light")) {
-            // apply the node's world transform on the light..
+            // Apply the node's world transform to the light.
             root.updateGeometricState();
             if (light != null) {
                 if (light instanceof DirectionalLight) {

+ 1 - 1
jme3-plugins/src/xml/java/com/jme3/export/xml/XMLExporter.java

@@ -65,7 +65,7 @@ public class XMLExporter implements JmeExporter {
     @Override
     public void save(Savable object, OutputStream f) throws IOException {
         try {
-            //Initialize Document when saving so we don't retain state of previous exports
+            // Initialize the Document when saving, so we don't retain state of previous exports.
             this.domOut = new DOMOutputCapsule(DocumentBuilderFactory.newInstance().newDocumentBuilder().newDocument(), this);
             domOut.write(object, object.getClass().getName(), null);
             DOMSerializer serializer = new DOMSerializer();

+ 2 - 2
jme3-terrain/src/main/java/com/jme3/terrain/heightmap/RawHeightMap.java

@@ -106,7 +106,7 @@ public class RawHeightMap extends AbstractHeightMap {
     }
 
     public RawHeightMap(URL resource, int size, int format, boolean swapxy) throws Exception {
-        // varify that resource and size are valid.
+        // Verify that resource and size are valid.
         if (null == resource || size <= 0) {
             throw new Exception("Must supply valid resource and "
                     + "size (> 0)");
@@ -121,7 +121,7 @@ public class RawHeightMap extends AbstractHeightMap {
     }
 
     private void setup(InputStream stream, int size, int format, boolean swapxy) throws Exception {
-        // varify that filename and size are valid.
+        // Verify that filename and size are valid.
         if (null == stream || size <= 0) {
             throw new Exception("Must supply valid stream and "
                     + "size (> 0)");

+ 1 - 1
jme3-vr/src/main/java/com/jme3/input/vr/VRAPI.java

@@ -63,7 +63,7 @@ public interface VRAPI {
 
     /**
      * Get the Head Mounted Device (HMD) display frequency.
-     * @return the Head Mounted DEvice (HMD) display frequency.
+     * @return the Head Mounted Device (HMD) display frequency.
      */
     public int getDisplayFrequency();
 

+ 1 - 1
jme3-vr/src/main/java/com/jme3/input/vr/VRInputAPI.java

@@ -117,7 +117,7 @@ public interface VRInputAPI {
     public Object getRawControllerState(int index);
 
     /**
-     * Swap the two hands (exchange the hands controller 1 and 2 indices).
+     * Swap the two hands (exchange the hands' controller 1 and 2 indices).
      */
     public void swapHands();
 

+ 1 - 1
jme3-vr/src/main/java/com/jme3/input/vr/oculus/OculusVR.java

@@ -44,7 +44,7 @@ public class OculusVR implements VRAPI {
 
     /**
      * Information about the VR session (should the app quit, is
-     * it visible or is the universal menu open, etc)
+     * it visible or is the universal menu open, etcetera)
      */
     private OVRSessionStatus sessionStatus;
 

+ 1 - 1
jme3-vr/src/main/java/com/jme3/input/vr/openvr/OpenVR.java

@@ -420,7 +420,7 @@ public class OpenVR implements VRAPI {
         // causing an invalid memory crash... skipping for now
         /*boolean hasEvent = false;
         while( JOpenVRLibrary.VR_IVRSystem_PollNextEvent(OpenVR.getVRSystemInstance(), tempEvent) != 0 ) {
-            // wait until the events are clear..
+            // Wait until the events are clear.
             hasEvent = true;
         }
         if( hasEvent ) {

+ 2 - 2
jme3-vr/src/main/java/com/jme3/input/vr/openvr/OpenVRViewManager.java

@@ -639,7 +639,7 @@ public class OpenVRViewManager extends AbstractVRViewManager {
     }
 
     /**
-     * Setup a distortion mesh for the stereo view.
+     * Set up a distortion mesh for the stereo view.
      * @param eye the eye to apply.
      * @param api the underlying VR api
      * @return the distorted mesh.
@@ -695,7 +695,7 @@ public class OpenVRViewManager extends AbstractVRViewManager {
             }
         }
 
-        // have UV coordinates & positions, now to setup indices
+        // have UV coordinates & positions, now set up indices
 
         int[] indices = new int[(int) ((m_iLensGridSegmentCountV - 1) * (m_iLensGridSegmentCountH - 1)) * 6];
         int indexPos = 0;

+ 3 - 3
jme3-vr/src/main/java/com/jme3/input/vr/osvr/OSVR.java

@@ -2,9 +2,9 @@
 
 https://github.com/sensics/OSVR-RenderManager/blob/master/examples/RenderManagerOpenGLCAPIExample.cpp
 
-- JVM crashes often.. placing breakpoints during initialization clears it up most of the time (WHY!?)
-  - OSVR is just unstable.. any way to improve things?
-- render manager looks good, but left eye seems stretched
+- JVM crashes often. Placing breakpoints during initialization clears it up most of the time (WHY!?)
+  - OSVR is just unstable. Any way to improve things?
+- Render manager looks good, but left eye seems stretched.
 
  */
 package com.jme3.input.vr.osvr;

+ 2 - 2
jme3-vr/src/main/java/com/jme3/input/vr/osvr/OSVRInput.java

@@ -74,12 +74,12 @@ public class OSVRInput implements VRInputAPI {
     }
 
     /**
-     * The left hand system String.
+     * The left-hand system String.
      */
     public static byte[] leftHand = { '/', 'm', 'e', '/', 'h', 'a', 'n', 'd', 's', '/', 'l', 'e', 'f', 't', (byte)0 };
 
     /**
-     * The right hand system String.
+     * The right-hand system String.
      */
     public static byte[] rightHand = { '/', 'm', 'e', '/', 'h', 'a', 'n', 'd', 's', '/', 'r', 'i', 'g', 'h', 't', (byte)0 };
 

+ 4 - 4
jme3-vr/src/main/java/com/jme3/input/vr/osvr/OSVRViewManager.java

@@ -533,7 +533,7 @@ public class OSVRViewManager extends AbstractVRViewManager{
 
         if (environment != null){
             if (environment.getApplication() != null){
-                // setup post processing filters
+                // set up post-processing filters
                 if( rightPostProcessor == null ) {
                     rightPostProcessor = new FilterPostProcessor(environment.getApplication().getAssetManager());
                     leftPostProcessor =  new FilterPostProcessor(environment.getApplication().getAssetManager());
@@ -569,7 +569,7 @@ public class OSVRViewManager extends AbstractVRViewManager{
                                 } else if (f instanceof DirectionalLightShadowFilter){
                                     f2 = FilterUtil.cloneDirectionalLightShadowFilter(environment.getApplication().getAssetManager(), (DirectionalLightShadowFilter)f);
                                 } else {
-                                    f2 = f; // dof, bloom, lightscattering etc.
+                                    f2 = f; // DoF, bloom, light scattering etc.
                                 }
                                 rightPostProcessor.addFilter(f2);
                             }
@@ -768,7 +768,7 @@ public class OSVRViewManager extends AbstractVRViewManager{
     }
 
     /**
-     * Setup a distortion mesh for the stereo view.
+     * Set up a distortion mesh for the stereo view.
      * @param eye the eye to apply.
      * @param api the underlying VR api
      * @return the distorted mesh.
@@ -824,7 +824,7 @@ public class OSVRViewManager extends AbstractVRViewManager{
             }
         }
 
-        // have UV coordinates & positions, now to setup indices
+        // have UV coordinates & positions, now set up indices
 
         int[] indices = new int[(int) ((m_iLensGridSegmentCountV - 1) * (m_iLensGridSegmentCountH - 1)) * 6];
         int indexPos = 0;

+ 1 - 1
jme3-vr/src/main/java/com/jme3/post/PreNormalCaching.java

@@ -36,7 +36,7 @@ public class PreNormalCaching {
         if( cachedPreNormals != null ) {
             r.copyFrameBuffer(cachedPreNormals, normalPass.getRenderFrameBuffer(),true,  false);
         } else {
-            // lets make the prenormals
+            // let's make the prenormals
             r.setFrameBuffer(normalPass.getRenderFrameBuffer());
             renderManager.getRenderer().clearBuffers(true, true, true);
             if( renderManager.getRenderer().getCaps().contains(Caps.GLSL150) ) {

+ 2 - 2
jme3-vr/src/main/java/com/jme3/system/osvr/osvrdisplay/OsvrDisplayLibrary.java

@@ -196,7 +196,7 @@ public class OsvrDisplayLibrary implements Library {
 	public static native byte osvrClientCheckDisplayStartup(OsvrDisplayLibrary.OSVR_DisplayConfig disp);
 	/**
 	 * A display config can have one or more display inputs to pass pixels<br>
-	 * over (HDMI/DVI connections, etc): retrieve the number of display inputs in<br>
+	 * over (HDMI/DVI connections, etcetera): retrieve the number of display inputs in<br>
 	 * the current configuration.<br>
 	 * @param disp Display config object.<br>
 	 * @param numDisplayInputs Number of display inputs in the logical display<br>
@@ -213,7 +213,7 @@ public class OsvrDisplayLibrary implements Library {
 	public static native byte osvrClientGetNumDisplayInputs(Pointer disp, Pointer numDisplayInputs);
 	/**
 	 * A display config can have one or more display inputs to pass pixels<br>
-	 * over (HDMI/DVI connections, etc): retrieve the number of display inputs in<br>
+	 * over (HDMI/DVI connections, etcetera): retrieve the number of display inputs in<br>
 	 * the current configuration.<br>
 	 * @param disp Display config object.<br>
 	 * @param numDisplayInputs Number of display inputs in the logical display<br>