java comments and javadoc

jme3-android-examples/src/main/java/org/jmonkeyengine/jme3androidexamples/CustomArrayAdapter.java

@@ -23,11 +23,11 @@ public class CustomArrayAdapter extends ArrayAdapter<String> {
     private int selectedPosition = -1;
     /* Background Color of selected item */
     private int selectedBackgroundColor = 0xffff00;
-    /* Background Color of non selected item */
+    /* Background Color of non-selected items */
     private int nonselectedBackgroundColor = 0x000000;
     /* Background Drawable Resource ID of selected item */
     private int selectedBackgroundResource = 0;
-    /* Background Drawable Resource ID of non selected items */
+    /* Background Drawable Resource ID of non-selected items */
     private int nonselectedBackgroundResource = 0;
 
     /* Variables to support list filtering */
@@ -53,7 +53,7 @@ public void setSelectedBackgroundColor(int selectedBackgroundColor) {
         this.selectedBackgroundColor = selectedBackgroundColor;
     }
 
-    /** Setter for non selected background color */
+    /** Setter for non-selected background color */
     public void setNonSelectedBackgroundColor(int nonselectedBackgroundColor) {
         this.nonselectedBackgroundColor = nonselectedBackgroundColor;
     }
@@ -63,7 +63,7 @@ public void setSelectedBackgroundResource(int selectedBackgroundResource) {
         this.selectedBackgroundResource = selectedBackgroundResource;
     }
 
-    /** Setter for non selected background resource id*/
+    /** Setter for non-selected background resource id*/
     public void setNonSelectedBackgroundResource(int nonselectedBackgroundResource) {
         this.nonselectedBackgroundResource = nonselectedBackgroundResource;
     }

jme3-bullet/src/common/java/com/jme3/bullet/control/BetterCharacterControl.java

@@ -308,7 +308,7 @@ public boolean isOnGround() {
      * Toggle character ducking. When ducked the characters capsule collision
      * shape height will be multiplied by duckedFactor to make the capsule
      * smaller. When unducking, the character will check with a ray test if it
-     * can in fact unduck and only do so when its possible. You can test the
+     * can in fact unduck and only do so when it's possible. You can test the
      * state using isDucked().
      *
      * @param enabled true→duck, false→unduck

jme3-bullet/src/common/java/com/jme3/bullet/debug/BulletDebugAppState.java

@@ -144,7 +144,7 @@ public DebugTools getNewDebugTools() {
     /**
      * Alter which objects are visualized.
      *
-     * @param filter the desired filter, or or null to visualize all objects
+     * @param filter the desired filter, or null to visualize all objects
      */
     public void setFilter(DebugAppStateFilter filter) {
         this.filter = filter;

jme3-core/src/main/java/com/jme3/anim/AnimationMask.java

@@ -39,7 +39,7 @@
 public interface AnimationMask {
 
     /**
-     * Test whether the animation should applied to the specified element.
+     * Test whether the animation should be applied to the specified element.
      *
      * @param target the target element
      * @return true if animation should be applied, otherwise false

jme3-core/src/main/java/com/jme3/anim/Armature.java

@@ -226,7 +226,7 @@ public void saveBindPose() {
     }
 
     /**
-     * This methods sets this armature in its bind pose (aligned with the mesh to deform)
+     * This method sets this armature to its bind pose (aligned with the mesh to deform).
      * Note that this is only useful for debugging purpose.
      */
     public void applyBindPose() {

jme3-core/src/main/java/com/jme3/anim/tween/action/BlendAction.java

@@ -57,7 +57,7 @@ public void doInterpolate(double t) {
         firstActiveAction.setCollectTransformDelegate(this);
         secondActiveAction.setCollectTransformDelegate(this);
 
-        //only interpolate the first action if the weight if below 1.
+        // Only interpolate the first action if the weight is below 1.
         if (blendWeight < 1f) {
             firstActiveAction.setWeight(1f);
             firstActiveAction.interpolate(t * timeFactor[firstActiveIndex]);

jme3-core/src/main/java/com/jme3/animation/AnimChannel.java

@@ -38,7 +38,7 @@
 
 /**
  * <code>AnimChannel</code> provides controls, such as play, pause,
- * fast forward, etc, for an animation. The animation
+ * fast forward, etcetera, for an animation. The animation
  * channel may influence the entire model or specific bones of the model's
  * skeleton. A single model may have multiple animation channels influencing
  * various parts of its body. For example, a character model may have an

jme3-core/src/main/java/com/jme3/animation/AnimControl.java

@@ -381,7 +381,7 @@ public void read(JmeImporter im) throws IOException {
 
             // If we find a target mesh array the AnimControl creates the 
             // SkeletonControl for old files and add it to the spatial.        
-            // When backward compatibility won't be needed anymore this can deleted        
+            // When backward compatibility isn't needed anymore, this can be deleted.
             Savable[] sav = in.readSavableArray("targets", null);
             if (sav != null) {
                 // NOTE: allow the targets to be gathered automatically

jme3-core/src/main/java/com/jme3/animation/Animation.java

@@ -225,7 +225,7 @@ public Object jmeClone() {
     @Override   
     public void cloneFields( Cloner cloner, Object original ) {
 
-        // There is some logic here that I'm copying but I'm not sure if
+        // There is some logic here that I'm copying, but I'm not sure if
         // it's a mistake or not.  If a track is not a CloneableTrack then it
         // isn't cloned at all... even though they all implement clone() methods. -pspeed
         SafeArrayList<Track> newTracks = new SafeArrayList<>(Track.class);
@@ -261,8 +261,8 @@ public void read(JmeImporter im) throws IOException {
 
         Savable[] arr = in.readSavableArray("tracks", null);
         if (arr != null) {
-            // NOTE: Backward compat only .. Some animations have no
-            // tracks set at all even though it makes no sense.
+            // NOTE: Backward compatibility only. Some animations have no
+            // tracks set at all, even though it makes no sense.
             // Since there's a null check in setTime(),
             // it's only appropriate that the check is made here as well.
             tracks = new SafeArrayList<>(Track.class);

jme3-core/src/main/java/com/jme3/animation/AudioTrack.java

@@ -44,9 +44,9 @@
 
 /**
  * AudioTrack is a track to add to an existing animation, to play a sound during
- * an animations for example : gun shot, foot step, shout, etc...
+ * an animations for example : gunshot, footstep, shout, etcetera.
  *
- * usage is
+ * Typical usage is:
  * <pre>
  * AnimControl control model.getControl(AnimControl.class);
  * AudioTrack track = new AudioTrack(existingAudioNode, control.getAnim("TheAnim").getLength());

jme3-core/src/main/java/com/jme3/animation/Bone.java

@@ -170,7 +170,7 @@ public Bone(String name) {
         modelBindInverseRot = source.modelBindInverseRot.clone();
         modelBindInverseScale = source.modelBindInverseScale.clone();
 
-        // parent and children will be assigned manually..
+        // Parent and children will be assigned manually.
     }
 
     /**
@@ -476,11 +476,11 @@ public final void updateWorldVectors(){
 
 
     /**
-     * Updates the model transforms for this bone, and, possibly the attach node
+     * Updates the model transforms for this bone and, possibly, the attachments node
      * if not null.
      * <p>
      * The model transform of this bone is computed by combining the parent's
-     * model transform with this bones' local transform.
+     * model transform with this bone's local transform.
      */
     public final void updateModelTransforms() {
         if (currentWeightSum == 1f) {
@@ -642,7 +642,7 @@ void getOffsetTransform(Matrix4f outTransform, Quaternion tmp1, Vector3f tmp2, V
         Quaternion rotate = modelRot.mult(modelBindInverseRot, tmp1);
 
         // Computing translation
-        // Translation depend on rotation and scale
+        // Translation depends on rotation and scale.
         Vector3f translate = modelPos.add(rotate.mult(scale.mult(modelBindInversePos, tmp2), tmp2), tmp2);
 
         // Populating the matrix
@@ -734,7 +734,7 @@ Node getAttachmentsNode(int boneIndex, SafeArrayList<Geometry> targets) {
         if (attachNode == null) {
             attachNode = new Node(name + "_attachnode");
             attachNode.setUserData("AttachedBone", this);
-            //We don't want the node to have a numBone set by a parent node so we force it to null
+            //We don't want the node to have NumberOfBones set by a parent node, so we force it to null.
             attachNode.addMatParamOverride(new MatParamOverride(VarType.Int, "NumberOfBones", null));
         }
 
@@ -966,7 +966,7 @@ public void setLocalScale(Vector3f scale){
     /**
      * returns true if this bone can be directly manipulated by the user.
      * @see #setUserControl(boolean)
-     * @return true if can be manipulated
+     * @return true if it can be manipulated
      */
     public boolean hasUserControl(){
         return userControl;

jme3-core/src/main/java/com/jme3/animation/ClonableTrack.java

@@ -63,7 +63,7 @@ public interface ClonableTrack extends Track, JmeCloneable {
     public Track cloneForSpatial(Spatial spatial);
 
     /**
-     * Method responsible of cleaning UserData on referenced Spatials when the Track is deleted
+     * Method responsible for cleaning UserData on referenced Spatials when the Track is deleted
      */
     public void cleanUp();
 }

jme3-core/src/main/java/com/jme3/app/BasicProfiler.java

@@ -81,7 +81,7 @@ public BasicProfiler( int size ) {
     }
 
     /**
-     *  Sets the number of frames to display and track.  By default
+     *  Sets the number of frames to display and track.  By default,
      *  this is 1280.
      * 
      * @param size the desired number of frames (≥0, default=1280)
@@ -107,7 +107,7 @@ public int getFrameCount() {
 
     /**
      *  Sets the number of nanoseconds to wait before updating the
-     *  mesh.  By default this is once a millisecond, ie: 1000000 nanoseconds.
+     *  mesh.  By default, this is once a millisecond, i.e. 1000000 nanoseconds.
      * 
      * @param nanos the desired update interval (in nanoseconds, default=1e6)
      */

jme3-core/src/main/java/com/jme3/app/state/AppStateManager.java

@@ -240,7 +240,7 @@ public <T extends AppState> T getState(Class<T> stateClass){
      *
      * @param <T> the desired type of AppState
      * @param stateClass the desired type of AppState
-     * @param failOnMiss true to thrown an exception, false to return null
+     * @param failOnMiss true to throw an exception, false to return null
      * @return First attached state that is an instance of stateClass. If failOnMiss is true 
      * then an IllegalArgumentException is thrown if the state is not attached.
      */
@@ -254,7 +254,7 @@ public <T extends AppState> T getState(Class<T> stateClass, boolean failOnMiss){
                 }
             }
 
-            // This may be more trouble than it's worth but I think
+            // This may be more trouble than it's worth, but I think
             // it's necessary for proper decoupling of states and provides
             // similar behavior to before where a state could be looked
             // up even if it wasn't initialized. -pspeed

jme3-core/src/main/java/com/jme3/asset/AssetEventListener.java

@@ -51,7 +51,7 @@ public interface AssetEventListener {
     public void assetLoaded(AssetKey key);
 
     /**
-     * Called when an asset has been requested (e.g any of the load*** methods
+     * Called when an asset has been requested (e.g. any of the load*** methods
      * in AssetManager are called).
      * In contrast to the assetLoaded() method, this one will be called even
      * if the asset has failed to load, or if it was retrieved from the cache.

jme3-core/src/main/java/com/jme3/asset/AssetKey.java

@@ -122,7 +122,7 @@ public String getFolder(){
 
     /**
      * @return The preferred cache class for this asset type. Specify "null"
-     * if caching is to be disabled. By default the 
+     * if caching is to be disabled. By default, the
      * {@link SimpleAssetCache} is returned.
      */
     public Class<? extends AssetCache> getCacheType(){

jme3-core/src/main/java/com/jme3/asset/AssetLocator.java

@@ -39,7 +39,7 @@
 public interface AssetLocator {
     /**
      * @param rootPath The root path where to look for assets.
-     * Typically this method will only be called once per
+     * Typically, this method will only be called once for each
      * instance of an asset locator.
      */
     public void setRootPath(String rootPath);

jme3-core/src/main/java/com/jme3/asset/AssetProcessor.java

@@ -37,7 +37,7 @@
 /**
  * <code>AssetProcessor</code> is used to apply processing to assets
  * after they have been loaded. They are assigned to a particular
- * asset type (which is represented by a {@link Class} and any assets
+ * asset type (which is represented by a {@link Class}) and any assets
  * loaded that are of that class will be processed by the assigned
  * processor.
  * 

jme3-core/src/main/java/com/jme3/asset/cache/AssetCache.java

@@ -56,8 +56,8 @@ public interface AssetCache {
      * Adds an asset to the cache.
      * Once added, it should be possible to retrieve the asset
      * by using the {@link #getFromCache(com.jme3.asset.AssetKey) } method.
-     * However the caching criteria may at some point choose that the asset
-     * should be removed from the cache to save memory, in that case, 
+     * However, the caching criteria may at some point decide that the asset
+     * should be removed from the cache to save memory. In that case,
      * {@link #getFromCache(com.jme3.asset.AssetKey) } will return null.
      * <p>Thread-Safe</p>
      * 
@@ -98,7 +98,7 @@ public interface AssetCache {
      * <p>Thread-Safe</p>
      * 
      * @param <T> The type of the asset to retrieve
-     * @param key The key used to lookup the asset.
+     * @param key The key used to look up the asset.
      * @return The asset that was previously cached, or null if not found.
      */
     public <T> T getFromCache(AssetKey<T> key);

jme3-core/src/main/java/com/jme3/audio/AudioData.java

@@ -92,7 +92,7 @@ public int getSampleRate() {
     }
 
     /**
-     * Setup the format of the audio data.
+     * Sets the format of the audio data.
      * @param channels # of channels, 1 = mono, 2 = stereo
      * @param bitsPerSample Bits per sample, e.g 8 bits, 16 bits.
      * @param sampleRate Sample rate, 44100, 22050, etc.

jme3-core/src/main/java/com/jme3/audio/AudioNode.java

@@ -785,7 +785,7 @@ public void cloneFields( Cloner cloner, Object original ) {
         // a filter change from one AudioNode when a different AudioNode's
         // filter attributes are updated.
         // Plus if they disable and re-enable the thing using the filter then
-        // the settings get reapplied and it might be surprising to have them
+        // the settings get reapplied, and it might be surprising to have them
         // suddenly be strange.
         // ...so I'll clone them.  -pspeed
         this.dryFilter = cloner.clone(dryFilter);

jme3-core/src/main/java/com/jme3/audio/openal/AL.java

@@ -45,11 +45,11 @@ public interface AL {
     public static final int AL_PITCH = 0x1003;
 
     /**
-     * Specify the current location in three dimensional space. OpenAL, like
-     * OpenGL, uses a right handed coordinate system, where in a frontal default
+     * Specify the current location in three-dimensional space. OpenAL, like
+     * OpenGL, uses a right-handed coordinate system, where in a frontal default
      * view X (thumb) points right, Y points up (index finger), and Z points
-     * towards the viewer/camera (middle finger). To switch from a left handed
-     * coordinate system, flip the sign on the Z coordinate. Listener position
+     * towards the viewer/camera (middle finger). To switch from a left-handed
+     * coordinate system, flip the sign of the Z coordinate. Listener position
      * is always in the world coordinate system.
      */
     public static final int AL_POSITION = 0x1004;
@@ -60,7 +60,7 @@ public interface AL {
     public static final int AL_DIRECTION = 0x1005;
 
     /**
-     * Specify the current velocity in three dimensional space.
+     * Specify the current velocity in three-dimensional space.
      */
     public static final int AL_VELOCITY = 0x1006;
 

jme3-core/src/main/java/com/jme3/audio/openal/ALAudioRenderer.java

@@ -377,12 +377,12 @@ public void updateSourceParam(AudioSource src, AudioParam param) {
             // There is a race condition in AudioSource that can
             // cause this to be called for a node that has been
             // detached from its channel.  For example, setVolume()
-            // called from the render thread may see that that AudioSource
+            // called from the render thread may see that the AudioSource
             // still has a channel value but the audio thread may
             // clear that channel before setVolume() gets to call
             // updateSourceParam() (because the audio stopped playing
             // on its own right as the volume was set).  In this case, 
-            // it should be safe to just ignore the update
+            // it should be safe to just ignore the update.
             if (src.getChannel() < 0) {
                 return;
             }

jme3-core/src/main/java/com/jme3/bounding/BoundingBox.java

@@ -943,7 +943,7 @@ public float distanceToEdge(Vector3f point) {
      */
     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) {
             // This is the old if statement...

jme3-core/src/main/java/com/jme3/bounding/BoundingSphere.java

@@ -952,7 +952,7 @@ private int collideWithTri(Triangle tri, CollisionResults results) {
                 return 1;              
             }
 
-            // Finally check each of the triangle corners
+            // Finally, check each of the triangle corners.
 
             // Vert A
             base = a;

jme3-core/src/main/java/com/jme3/cinematic/Cinematic.java

@@ -77,7 +77,7 @@
  * @see Cinematic#stop()
  *
  * A cinematic is itself a CinematicEvent, meaning you can embed several
- * Cinematics Embed cinematics must not be added to the stateManager though.
+ * Cinematics. Embedded cinematics must not be added to the stateManager though.
  *
  * Cinematic has a way to handle several point of view by creating CameraNode
  * over a cam and activating them on schedule.
@@ -727,7 +727,7 @@ public void clear() {
     }
 
     /**
-     * used internally to cleanup the cinematic. Called when the clear() method
+     * used internally to clean up the cinematic. Called when the clear() method
      * is called
      */
     @Override

jme3-core/src/main/java/com/jme3/cinematic/events/CinematicEvent.java

@@ -57,7 +57,7 @@ public interface CinematicEvent extends Savable {
      * this method can be implemented if the event needs different handling when 
      * stopped naturally (when the event reach its end)
      * or when it was forced stopped during playback
-     * otherwise it just call regular stop()
+     * otherwise it just calls regular stop()
      */
     public void forceStop();
 

jme3-core/src/main/java/com/jme3/effect/influencers/DefaultParticleInfluencer.java

@@ -44,7 +44,7 @@
 
 /**
  * This emitter influences the particles so that they move all in the same direction.
- * The direction may vary a little if the velocity variation is non zero.
+ * The direction may vary a little if the velocity variation is non-zero.
  * This influencer is default for the particle emitter.
  * @author Marcin Roguski (Kaelthas)
  */