Javadoc fixes and links for the com.jme3.animation package; Added missing license header

git-svn-id: https://jmonkeyengine.googlecode.com/svn/trunk@8009 75d07b2b-3a1a-0410-a2c5-0572b91ccdca

engine/src/core/checkers/quals/DefaultLocation.java

@@ -18,7 +18,7 @@ public enum DefaultLocation {
      * explicit ones in <tt>extends</tt> clauses, and implicit upper bounds
      * when no explicit <tt>extends</tt> or <tt>super</tt> clause is
      * present. */
-    // Especially useful for parametrized classes that provide a lot of
+    // Especially useful for parameterized classes that provide a lot of
     // static methods with the same generic parameters as the class.
     UPPER_BOUNDS;
 

engine/src/core/com/jme3/animation/AnimChannel.java

@@ -175,7 +175,7 @@ public final class AnimChannel {
 
     /**
      * @param time Set the time of the currently playing animation, the time
-     * is clamped from 0 to getAnimMaxTime().
+     * is clamped from 0 to {@link #getAnimMaxTime()}. 
      */
     public void setTime(float time) {
         this.time = FastMath.clamp(time, 0, getAnimMaxTime());
@@ -235,7 +235,7 @@ public final class AnimChannel {
     /**
      * Set the current animation that is played by this AnimChannel.
      * <p>
-     * See {@link #setAnim(java.lang.String, float) }.
+     * See {@link #setAnim(java.lang.String, float)}.
      * The blendTime argument by default is 150 milliseconds.
      * 
      * @param name The name of the animation to play

engine/src/core/com/jme3/animation/Animation.java

@@ -1,3 +1,34 @@
+/*
+ * Copyright (c) 2009-2011 jMonkeyEngine
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ * * Redistributions of source code must retain the above copyright
+ *   notice, this list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright
+ *   notice, this list of conditions and the following disclaimer in the
+ *   documentation and/or other materials provided with the distribution.
+ *
+ * * Neither the name of 'jMonkeyEngine' nor the names of its contributors
+ *   may be used to endorse or promote products derived from this software
+ *   without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+ * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
 package com.jme3.animation;
 
 import com.jme3.export.Savable;

engine/src/core/com/jme3/animation/BoneTrack.java

@@ -77,7 +77,7 @@ public final class BoneTrack implements Savable {
      * @param targetBoneIndex the bone index
      * @param times a float array with the time of each frame
      * @param translations the translation of the bone for each frame
-     * @param rotations the rontation of the bone for each frame
+     * @param rotations the rotation of the bone for each frame
      */
     public BoneTrack(int targetBoneIndex, float[] times, Vector3f[] translations, Quaternion[] rotations) {
         this.targetBoneIndex = targetBoneIndex;
@@ -89,7 +89,7 @@ public final class BoneTrack implements Savable {
      * @param targetBoneIndex the bone index
      * @param times a float array with the time of each frame
      * @param translations the translation of the bone for each frame
-     * @param rotations the rontation of the bone for each frame
+     * @param rotations the rotation of the bone for each frame
      * @param scales the scale of the bone for each frame
      */
     public BoneTrack(int targetBoneIndex, float[] times, Vector3f[] translations, Quaternion[] rotations, Vector3f[] scales) {
@@ -149,7 +149,7 @@ public final class BoneTrack implements Savable {
      * Set the translations and rotations for this bone track
      * @param times a float array with the time of each frame
      * @param translations the translation of the bone for each frame
-     * @param rotations the rontation of the bone for each frame
+     * @param rotations the rotation of the bone for each frame
      */
     public void setKeyframes(float[] times, Vector3f[] translations, Quaternion[] rotations) {
         if (times.length == 0) {
@@ -171,7 +171,7 @@ public final class BoneTrack implements Savable {
      *  Set the translations, rotations and scales for this bone track
      * @param times a float array with the time of each frame
      * @param translations the translation of the bone for each frame
-     * @param rotations the rontation of the bone for each frame
+     * @param rotations the rotation of the bone for each frame
      * @param scales the scale of the bone for each frame
      */
     public void setKeyframes(float[] times, Vector3f[] translations, Quaternion[] rotations, Vector3f[] scales) {

engine/src/core/com/jme3/animation/CompactQuaternionArray.java

@@ -41,20 +41,20 @@ import com.jme3.export.Savable;
 import com.jme3.math.Quaternion;
 
 /**
- * Serialize and compress Quaternion[] by indexing same values
+ * Serialize and compress {@link Quaternion}[] by indexing same values
  * It is converted to float[]
  * @author Lim, YongHoon
  */
 public class CompactQuaternionArray extends CompactArray<Quaternion> implements Savable {
 
     /**
-     * creates a compact quaternion array
+     * creates a compact Quaternion array
      */
     public CompactQuaternionArray() {
     }
 
     /**
-     * creates a compact quaternion array
+     * creates a compact Quaternion array
      * @param dataArray the data array
      * @param index  the indices array
      */

engine/src/core/com/jme3/animation/Pose.java

@@ -43,7 +43,7 @@ import java.io.IOException;
 import java.nio.FloatBuffer;
 
 /**
- * A pose is a list of offsets that say where a mesh verticles should be for this pose.
+ * A pose is a list of offsets that say where a mesh vertices should be for this pose.
  */
 public final class Pose implements Savable {
 
@@ -71,7 +71,7 @@ public final class Pose implements Savable {
     /**
      * Applies the offsets of this pose to the vertex buffer given by the blend factor.
      *
-     * @param blend Blend factor, 0 = no change to vert buf, 1 = apply full offsets
+     * @param blend Blend factor, 0 = no change to vertex buffer, 1 = apply full offsets
      * @param vertbuf Vertex buffer to apply this pose to
      */
     public void apply(float blend, FloatBuffer vertbuf){
@@ -81,13 +81,13 @@ public final class Pose implements Savable {
 
             tempVec.set(offset).multLocal(blend);
 
-            // aquire vert
+            // acquire vertex
             BufferUtils.populateFromBuffer(tempVec2, vertbuf, vertIndex);
 
             // add offset multiplied by factor
             tempVec2.addLocal(tempVec);
 
-            // write modified vert
+            // write modified vertex
             BufferUtils.setInBuffer(tempVec2, vertbuf, vertIndex);
         }
     }