Fixes some warnings in the Java documentation of ardor3d-core

9 files changed, 137 insertions, 77 deletions

diff --git a/ardor3d-core/src/main/java/com/ardor3d/image/Texture.java b/ardor3d-core/src/main/java/com/ardor3d/image/Texture.java
index 241b16a..e5cf463 100644
--- a/ardor3d-core/src/main/java/com/ardor3d/image/Texture.java
+++ b/ardor3d-core/src/main/java/com/ardor3d/image/Texture.java
@@ -3,7 +3,7 @@
  *
  * This file is part of Ardor3D.
  *
- * Ardor3D is free software: you can redistribute it and/or modify it 
+ * Ardor3D is free software: you can redistribute it and/or modify it
  * under the terms of its license which may be found in the accompanying
  * LICENSE file or at <http://www.ardor3d.com/LICENSE>.
  */
@@ -32,7 +32,7 @@ import com.ardor3d.util.export.Savable;
  * within this class. This includes mipmapping if desired, magnificationFilter options, apply options and correction
  * options. Default values are as follows: minificationFilter - NearestNeighborNoMipMaps, magnificationFilter -
  * NearestNeighbor, wrap - EdgeClamp on S,T and R, apply - Modulate, environment - None.
- * 
+ *
  * @see com.ardor3d.image.Image
  */
 public abstract class Texture implements Savable {
@@ -498,11 +498,12 @@ public abstract class Texture implements Savable {
     /**
      * Constructor instantiates a new <code>Texture</code> object with default attributes.
      */
-    public Texture() {}
+    public Texture() {
+    }
 
     /**
      * sets a color that is used with CombinerSource.Constant
-     * 
+     *
      * @param color
      *            the new constant color (the default is {@link ColorRGBA#BLACK_NO_ALPHA})
      */
@@ -512,11 +513,15 @@ public abstract class Texture implements Savable {
 
     /**
      * sets a color that is used with CombinerSource.Constant
-     * 
+     *
      * @param red
+     *            the red value
      * @param green
+     *            the green value
      * @param blue
+     *            the blue value
      * @param alpha
+     *            the alpha value
      */
     public void setConstantColor(final float red, final float green, final float blue, final float alpha) {
         _constantColor.set(red, green, blue, alpha);
@@ -524,7 +529,7 @@ public abstract class Texture implements Savable {
 
     /**
      * sets the color used when texture operations encounter the border of a texture.
-     * 
+     *
      * @param color
      *            the new border color (the default is {@link ColorRGBA#BLACK_NO_ALPHA})
      */
@@ -534,11 +539,15 @@ public abstract class Texture implements Savable {
 
     /**
      * sets the color used when texture operations encounter the border of a texture.
-     * 
+     *
      * @param red
+     *            the red value
      * @param green
+     *            the green value
      * @param blue
+     *            the blue value
      * @param alpha
+     *            the alpha value
      */
     public void setBorderColor(final float red, final float green, final float blue, final float alpha) {
         _borderColor.set(red, green, blue, alpha);
@@ -586,7 +595,7 @@ public abstract class Texture implements Savable {
 
     /**
      * <code>setApply</code> sets the apply mode for this texture.
-     * 
+     *
      * @param apply
      *            the apply mode for this texture.
      * @throws IllegalArgumentException
@@ -601,7 +610,7 @@ public abstract class Texture implements Savable {
 
     /**
      * <code>setImage</code> sets the image object that defines the texture.
-     * 
+     *
      * @param image
      *            the image that defines the texture.
      */
@@ -634,7 +643,7 @@ public abstract class Texture implements Savable {
 
     /**
      * Sets the id for this texture in regards to the given OpenGL context.
-     * 
+     *
      * @param glContext
      *            the object representing the OpenGL context this texture belongs to. See
      *            {@link RenderContext#getGlContextRep()}
@@ -655,7 +664,7 @@ public abstract class Texture implements Savable {
      * Note: This does not remove the texture from the card and is provided for use by code that does remove textures
      * from the card.
      * </p>
-     * 
+     *
      * @param glContext
      *            the object representing the OpenGL context this texture belongs to. See
      *            {@link RenderContext#getGlContextRep()}
@@ -695,7 +704,7 @@ public abstract class Texture implements Savable {
 
     /**
      * Sets the wrap mode of this texture for a particular axis.
-     * 
+     *
      * @param axis
      *            the texture axis to define a wrapmode on.
      * @param mode
@@ -707,7 +716,7 @@ public abstract class Texture implements Savable {
 
     /**
      * Sets the wrap mode of this texture for all axis.
-     * 
+     *
      * @param mode
      *            the wrap mode for the given axis of the texture.
      * @throws IllegalArgumentException
@@ -1052,6 +1061,7 @@ public abstract class Texture implements Savable {
 
     /**
      * @param envMapMode
+     *            the environmental map mode to set
      * @throws IllegalArgumentException
      *             if envMapMode is null
      */
@@ -1203,7 +1213,7 @@ public abstract class Texture implements Savable {
 
     /**
      * Get the depth texture compare function
-     * 
+     *
      * @return The depth texture compare function
      */
     public DepthTextureCompareFunc getDepthCompareFunc() {
@@ -1212,8 +1222,9 @@ public abstract class Texture implements Savable {
 
     /**
      * Set the depth texture compare function
-     * 
-     * param depthCompareFunc The depth texture compare function
+     *
+     * @param depthCompareFunc
+     *            The depth texture compare function
      */
     public void setDepthCompareFunc(final DepthTextureCompareFunc depthCompareFunc) {
         _depthCompareFunc = depthCompareFunc;
@@ -1221,7 +1232,7 @@ public abstract class Texture implements Savable {
 
     /**
      * Get the depth texture apply mode
-     * 
+     *
      * @return The depth texture apply mode
      */
     public DepthTextureMode getDepthMode() {
@@ -1230,7 +1241,7 @@ public abstract class Texture implements Savable {
 
     /**
      * Set the depth texture apply mode
-     * 
+     *
      * @param depthMode
      *            The depth texture apply mode
      */
@@ -1240,7 +1251,7 @@ public abstract class Texture implements Savable {
 
     /**
      * Get the depth texture compare mode
-     * 
+     *
      * @return The depth texture compare mode
      */
     public DepthTextureCompareMode getDepthCompareMode() {
@@ -1249,7 +1260,7 @@ public abstract class Texture implements Savable {
 
     /**
      * Set the depth texture compare mode
-     * 
+     *
      * @param depthCompareMode
      *            The depth texture compare mode
      */
@@ -1354,7 +1365,10 @@ public abstract class Texture implements Savable {
 
     /**
      * Retrieve a basic clone of this Texture (ie, clone everything but the image data, which is shared)
-     * 
+     *
+     * @param rVal
+     *            the texture to clone
+     *
      * @return Texture
      */
     public Texture createSimpleClone(final Texture rVal) {
diff --git a/ardor3d-core/src/main/java/com/ardor3d/input/ControllerState.java b/ardor3d-core/src/main/java/com/ardor3d/input/ControllerState.java
index da1c7fe..1bfb205 100644
--- a/ardor3d-core/src/main/java/com/ardor3d/input/ControllerState.java
+++ b/ardor3d-core/src/main/java/com/ardor3d/input/ControllerState.java
@@ -29,7 +29,8 @@ public class ControllerState {
     protected final Map<String, Map<String, Float>> _controllerStates = new LinkedHashMap<>();
     protected final List<ControllerEvent> _eventsSinceLastState = new ArrayList<>();
 
-    protected ControllerState(final int ignore) {}
+    protected ControllerState(final int ignore) {
+    }
 
     public ControllerState() {
         ControllerState.NOTHING.duplicateStates(_controllerStates);
@@ -45,6 +46,13 @@ public class ControllerState {
 
     /**
      * Sets a components state
+     *
+     * @param controllerName
+     *            the controller's name
+     * @param componentName
+     *            the component's name
+     * @param value
+     *            the value
      */
     public void set(final String controllerName, final String componentName, final float value) {
         Map<String, Float> controllerState = null;
diff --git a/ardor3d-core/src/main/java/com/ardor3d/input/InputState.java b/ardor3d-core/src/main/java/com/ardor3d/input/InputState.java
index 263d4a3..1fdd81f 100644
--- a/ardor3d-core/src/main/java/com/ardor3d/input/InputState.java
+++ b/ardor3d-core/src/main/java/com/ardor3d/input/InputState.java
@@ -3,7 +3,7 @@
  *
  * This file is part of Ardor3D.
  *
- * Ardor3D is free software: you can redistribute it and/or modify it 
+ * Ardor3D is free software: you can redistribute it and/or modify it
  * under the terms of its license which may be found in the accompanying
  * LICENSE file or at <http://www.ardor3d.com/LICENSE>.
  */
@@ -28,11 +28,13 @@ public class InputState {
 
     /**
      * Creates a new instance.
-     * 
+     *
      * @param keyboardState
      *            a non-null KeyboardState instance
      * @param mouseState
      *            a non-null MouseState instance
+     * @param controllerState
+     *            a non-null ControllerState instance
      * @throws NullPointerException
      *             if either parameter is null
      */
diff --git a/ardor3d-core/src/main/java/com/ardor3d/renderer/pass/Pass.java b/ardor3d-core/src/main/java/com/ardor3d/renderer/pass/Pass.java
index a87f887..49fc26b 100644
--- a/ardor3d-core/src/main/java/com/ardor3d/renderer/pass/Pass.java
+++ b/ardor3d-core/src/main/java/com/ardor3d/renderer/pass/Pass.java
@@ -129,7 +129,13 @@ public abstract class Pass implements Serializable {
         throw new UnsupportedOperationException("This pass type does not support RTT use.");
     }
 
-    /** if enabled, call doUpdate to update information for this pass. */
+    /**
+     * if enabled, call doUpdate to update information for this pass.
+     *
+     *
+     * @param tpf
+     *            the time per frame
+     */
     public final void updatePass(final double tpf) {
         if (!_enabled) {
             return;
diff --git a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/Node.java b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/Node.java
index 1518f8d..5b7c29f 100644
--- a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/Node.java
+++ b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/Node.java
@@ -3,7 +3,7 @@
  *
  * This file is part of Ardor3D.
  *
- * Ardor3D is free software: you can redistribute it and/or modify it 
+ * Ardor3D is free software: you can redistribute it and/or modify it
  * under the terms of its license which may be found in the accompanying
  * LICENSE file or at <http://www.ardor3d.com/LICENSE>.
  */
@@ -50,7 +50,7 @@ public class Node extends Spatial {
 
     /**
      * Constructs a new <code>Node</code> with a given name.
-     * 
+     *
      * @param name
      *            the name of the node. This is required for identification purposes.
      */
@@ -60,7 +60,7 @@ public class Node extends Spatial {
 
     /**
      * Constructs a new <code>Node</code> with a given name.
-     * 
+     *
      * @param name
      *            the name of the node. This is required for identification purposes.
      * @param children
@@ -73,11 +73,11 @@ public class Node extends Spatial {
     }
 
     /**
-     * 
+     *
      * <code>attachChild</code> attaches a child to this node. This node becomes the child's parent. The current number
      * of children maintained is returned. <br>
      * If the child already had a parent it is detached from that former parent.
-     * 
+     *
      * @param child
      *            the child to attach to this node.
      * @return the number of children maintained by this node.
@@ -104,13 +104,15 @@ public class Node extends Spatial {
     }
 
     /**
-     * 
+     *
      * <code>attachChildAt</code> attaches a child to this node at an index. This node becomes the child's parent. The
      * current number of children maintained is returned. <br>
      * If the child already had a parent it is detached from that former parent.
-     * 
+     *
      * @param child
      *            the child to attach to this node.
+     * @param index
+     *            the index of the child to be attached.
      * @return the number of children maintained by this node.
      */
     public int attachChildAt(final Spatial child, final int index) {
@@ -136,7 +138,7 @@ public class Node extends Spatial {
 
     /**
      * <code>detachChild</code> removes a given child from the node's list. This child will no longe be maintained.
-     * 
+     *
      * @param child
      *            the child to remove.
      * @return the index the child was at. -1 if the child was not in the list.
@@ -159,7 +161,7 @@ public class Node extends Spatial {
     /**
      * <code>detachChild</code> removes a given child from the node's list. This child will no longe be maintained. Only
      * the first child with a matching name is removed.
-     * 
+     *
      * @param childName
      *            the child to remove.
      * @return the index the child was at. -1 if the child was not in the list.
@@ -179,9 +181,9 @@ public class Node extends Spatial {
     }
 
     /**
-     * 
+     *
      * <code>detachChildAt</code> removes a child at a given index. That child is returned for saving purposes.
-     * 
+     *
      * @param index
      *            the index of the child to be removed.
      * @return the child at the supplied index.
@@ -202,7 +204,7 @@ public class Node extends Spatial {
     }
 
     /**
-     * 
+     *
      * <code>detachAllChildren</code> removes all children attached to this node.
      */
     public void detachAllChildren() {
@@ -214,7 +216,7 @@ public class Node extends Spatial {
 
     /**
      * Get the index of the specified spatial.
-     * 
+     *
      * @param sp
      *            spatial to retrieve index for.
      * @return the index
@@ -225,7 +227,7 @@ public class Node extends Spatial {
 
     /**
      * Returns all children to this node.
-     * 
+     *
      * @return a list containing all children to this node
      */
     public List<Spatial> getChildren() {
@@ -234,9 +236,11 @@ public class Node extends Spatial {
 
     /**
      * Swaps two children.
-     * 
+     *
      * @param index1
+     *            the index of the first child to swap
      * @param index2
+     *            the index of the second child to swap
      */
     public void swapChildren(final int index1, final int index2) {
         final Spatial c2 = _children.get(index2);
@@ -257,9 +261,9 @@ public class Node extends Spatial {
     }
 
     /**
-     * 
+     *
      * <code>getChild</code> returns a child at a given index.
-     * 
+     *
      * @param i
      *            the index to retrieve the child from.
      * @return the child at a specified index.
@@ -271,7 +275,7 @@ public class Node extends Spatial {
     /**
      * <code>getChild</code> returns the first child found with exactly the given name (case sensitive.) If our children
      * are Nodes, we will search their children as well.
-     * 
+     *
      * @param name
      *            the name of the child to retrieve. If null, we'll return null.
      * @return the child if found, or null.
@@ -296,7 +300,7 @@ public class Node extends Spatial {
 
     /**
      * determines if the provided Spatial is contained in the children list of this node.
-     * 
+     *
      * @param spat
      *            the child object to look for.
      * @return true if the object is contained, false otherwise.
@@ -317,9 +321,9 @@ public class Node extends Spatial {
     }
 
     /**
-     * 
+     *
      * <code>getNumberOfChildren</code> returns the number of children this node maintains.
-     * 
+     *
      * @return the number of children this node maintains.
      */
     public int getNumberOfChildren() {
@@ -361,7 +365,7 @@ public class Node extends Spatial {
 
     /**
      * <code>draw</code> calls the onDraw method for each child maintained by this node.
-     * 
+     *
      * @see com.ardor3d.scenegraph.Spatial#draw(com.ardor3d.renderer.Renderer)
      * @param r
      *            the renderer to draw to.
@@ -393,7 +397,7 @@ public class Node extends Spatial {
     /**
      * <code>updateWorldBound</code> merges the bounds of all the children maintained by this node. This will allow for
      * faster culling operations.
-     * 
+     *
      * @see com.ardor3d.scenegraph.Spatial#updateWorldBound(boolean)
      */
     @Override
@@ -411,8 +415,8 @@ public class Node extends Spatial {
 
                     // simple check to catch NaN issues
                     if (!Vector3.isValid(worldBound.getCenter())) {
-                        throw new Ardor3dException("WorldBound center is invalid after merge between " + this + " and "
-                                + child);
+                        throw new Ardor3dException(
+                                "WorldBound center is invalid after merge between " + this + " and " + child);
                     }
                 } else {
                     // set world bound to first non-null child world bound
diff --git a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/hint/SceneHints.java b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/hint/SceneHints.java
index a56d106..95ad425 100644
--- a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/hint/SceneHints.java
+++ b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/hint/SceneHints.java
@@ -3,7 +3,7 @@
  *
  * This file is part of Ardor3D.
  *
- * Ardor3D is free software: you can redistribute it and/or modify it 
+ * Ardor3D is free software: you can redistribute it and/or modify it
  * under the terms of its license which may be found in the accompanying
  * LICENSE file or at <http://www.ardor3d.com/LICENSE>.
  */
@@ -99,7 +99,7 @@ public class SceneHints implements Savable {
     /**
      * Returns the normals mode. If the mode is set to inherit, then we get its normals mode from the given source's
      * hintable parent. If no parent, we'll default to NormalizeIfScaled.
-     * 
+     *
      * @return The normals mode to use.
      */
     public DataMode getDataMode() {
@@ -133,7 +133,7 @@ public class SceneHints implements Savable {
     /**
      * Returns the normals mode. If the mode is set to inherit, then we get its normals mode from the given source's
      * hintable parent. If no parent, we'll default to NormalizeIfScaled.
-     * 
+     *
      * @return The normals mode to use.
      */
     public NormalsMode getNormalsMode() {
@@ -194,7 +194,7 @@ public class SceneHints implements Savable {
      * throw away this object and any children during draw commands. CullHint.Never: Never throw away this object
      * (always draw it) CullHint.Inherit: Look for a non-inherit parent and use its cull mode. NOTE: You must set this
      * AFTER attaching to a parent or it will be reset with the parent's cullMode value.
-     * 
+     *
      * @param hint
      *            one of CullHint.Dynamic, CullHint.Always, CullHint.Inherit or CullHint.Never
      */
@@ -205,7 +205,7 @@ public class SceneHints implements Savable {
     /**
      * Returns this spatial's texture combine mode. If the mode is set to inherit, then the spatial gets its combine
      * mode from its parent.
-     * 
+     *
      * @return The spatial's texture current combine mode.
      */
     public TextureCombineMode getTextureCombineMode() {
@@ -230,7 +230,7 @@ public class SceneHints implements Savable {
 
     /**
      * Sets how textures from parents should be combined for this Spatial.
-     * 
+     *
      * @param mode
      *            The new texture combine mode for this spatial.
      * @throws IllegalArgumentException
@@ -246,7 +246,7 @@ public class SceneHints implements Savable {
     /**
      * Returns this spatial's light combine mode. If the mode is set to inherit, then the spatial gets its combine mode
      * from its parent.
-     * 
+     *
      * @return The spatial's light current combine mode.
      */
     public LightCombineMode getLightCombineMode() {
@@ -271,7 +271,7 @@ public class SceneHints implements Savable {
 
     /**
      * Sets how lights from parents should be combined for this spatial.
-     * 
+     *
      * @param mode
      *            The light combine mode for this spatial
      * @throws IllegalArgumentException
@@ -292,7 +292,7 @@ public class SceneHints implements Savable {
      * {@link com.ardor3d.renderer.queue.RenderBucketType#Inherit Inherit} then the bucket type from the spatial's
      * parent will be used during rendering. If no parent, then
      * {@link com.ardor3d.renderer.queue.RenderBucketType#Opaque Opaque} is used.
-     * 
+     *
      * @return the render queue mode used for this spatial.
      * @see com.ardor3d.renderer.queue.RenderBucketType
      */
@@ -317,7 +317,7 @@ public class SceneHints implements Savable {
      * {@link com.ardor3d.renderer.queue.RenderBucketType#Inherit Inherit} then the bucket type from the spatial's
      * parent will be used during rendering. If no parent, then
      * {@link com.ardor3d.renderer.queue.RenderBucketType#Opaque Opaque} is used.
-     * 
+     *
      * @return the render queue mode set on this spatial.
      * @see com.ardor3d.renderer.queue.RenderBucketType
      */
@@ -328,7 +328,7 @@ public class SceneHints implements Savable {
     /**
      * Set the render bucket type used to determine which "phase" of the rendering process this Spatial will rendered
      * in.
-     * 
+     *
      * @param renderBucketType
      *            the render bucket type to use for this spatial.
      * @see com.ardor3d.renderer.queue.RenderBucketType
@@ -339,7 +339,7 @@ public class SceneHints implements Savable {
 
     /**
      * Returns whether a certain pick hint is set on this spatial.
-     * 
+     *
      * @param pickingHint
      *            Pick hint to test for
      * @return Enabled or disabled
@@ -350,7 +350,7 @@ public class SceneHints implements Savable {
 
     /**
      * Enable or disable a picking hint for this Spatial
-     * 
+     *
      * @param pickingHint
      *            PickingHint to set. Pickable or Collidable
      * @param enabled
@@ -366,7 +366,7 @@ public class SceneHints implements Savable {
 
     /**
      * Enable or disable all picking hints for this Spatial
-     * 
+     *
      * @param enabled
      *            Enable or disable
      */
@@ -379,10 +379,9 @@ public class SceneHints implements Savable {
     }
 
     /**
-     * @return a number representing z ordering when used in the Ortho bucket. Higher values are
-     *         "further into the screen" and lower values are "closer". Or in other words, if you draw two quads, one
-     *         with a zorder of 1 and the other with a zorder of 2, the quad with zorder of 2 will be "under" the other
-     *         quad.
+     * @return a number representing z ordering when used in the Ortho bucket. Higher values are "further into the
+     *         screen" and lower values are "closer". Or in other words, if you draw two quads, one with a zorder of 1
+     *         and the other with a zorder of 2, the quad with zorder of 2 will be "under" the other quad.
      */
     public int getOrthoOrder() {
         return _orthoOrder;
@@ -390,6 +389,7 @@ public class SceneHints implements Savable {
 
     /**
      * @param orthoOrder
+     *            the ortho order
      */
     public void setOrthoOrder(final int orthoOrder) {
         _orthoOrder = orthoOrder;
@@ -398,7 +398,7 @@ public class SceneHints implements Savable {
     /**
      * Returns the transparency rendering type. If the mode is set to inherit, then we get its type from the given
      * source's hintable parent. If no parent, we'll default to OnePass.
-     * 
+     *
      * @return The transparency rendering type to use.
      */
     public TransparencyType getTransparencyType() {
diff --git a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/visitor/Visitor.java b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/visitor/Visitor.java
index ea22b8e..1a7a09a 100644
--- a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/visitor/Visitor.java
+++ b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/visitor/Visitor.java
@@ -3,7 +3,7 @@
  *
  * This file is part of Ardor3D.
  *
- * Ardor3D is free software: you can redistribute it and/or modify it 
+ * Ardor3D is free software: you can redistribute it and/or modify it
  * under the terms of its license which may be found in the accompanying
  * LICENSE file or at <http://www.ardor3d.com/LICENSE>.
  */
@@ -16,8 +16,9 @@ public interface Visitor {
 
     /**
      * Execute our logic on the given Spatial
-     * 
+     *
      * @param spatial
+     *            the spatial
      */
     void visit(Spatial spatial);
 }
diff --git a/ardor3d-core/src/main/java/com/ardor3d/util/export/xml/DOMOutputCapsule.java b/ardor3d-core/src/main/java/com/ardor3d/util/export/xml/DOMOutputCapsule.java
index 911f2f2..a892bde 100644
--- a/ardor3d-core/src/main/java/com/ardor3d/util/export/xml/DOMOutputCapsule.java
+++ b/ardor3d-core/src/main/java/com/ardor3d/util/export/xml/DOMOutputCapsule.java
@@ -3,7 +3,7 @@
  *
  * This file is part of Ardor3D.
  *
- * Ardor3D is free software: you can redistribute it and/or modify it 
+ * Ardor3D is free software: you can redistribute it and/or modify it
  * under the terms of its license which may be found in the accompanying
  * LICENSE file or at <http://www.ardor3d.com/LICENSE>.
  */
@@ -51,6 +51,10 @@ public class DOMOutputCapsule implements OutputCapsule {
     /**
      * appends a new Element with the given name to currentElement, sets currentElement to be new Element, and returns
      * the new Element as well
+     *
+     * @param name
+     *            the name of the new element
+     * @return the new element
      */
     private Element appendElement(final String name) {
         Element ret = null;
diff --git a/ardor3d-core/src/main/java/com/ardor3d/util/geom/BufferUtils.java b/ardor3d-core/src/main/java/com/ardor3d/util/geom/BufferUtils.java
index d6042f7..ae92c1f 100644
--- a/ardor3d-core/src/main/java/com/ardor3d/util/geom/BufferUtils.java
+++ b/ardor3d-core/src/main/java/com/ardor3d/util/geom/BufferUtils.java
@@ -56,6 +56,8 @@ public final class BufferUtils {
      *
      * @param data
      *            array of ColorRGBA objects to place into a new FloatBuffer
+     *
+     * @return the requested new FloatBuffer
      */
     public static FloatBuffer createFloatBuffer(final ReadOnlyColorRGBA... data) {
         if (data == null) {
@@ -74,6 +76,7 @@ public final class BufferUtils {
      *            the number of colors to read
      * @param data
      *            array of ColorRGBA objects to place into a new FloatBuffer
+     * @return the requested new FloatBuffer
      */
     public static FloatBuffer createFloatBuffer(final int offset, final int length, final ReadOnlyColorRGBA... data) {
         if (data == null) {
@@ -206,7 +209,7 @@ public final class BufferUtils {
     }
 
     /**
-     * Checks to see if the given ColorRGBA is equals to the data stored in the buffer at the given data index.
+     * Checks to see if the given ColorRGBA is equal to the data stored in the buffer at the given data index.
      *
      * @param check
      *            the color to check against - null will return false.
@@ -214,7 +217,8 @@ public final class BufferUtils {
      *            the buffer to compare data with
      * @param index
      *            the position (in terms of colors, not floats) of the color in the buffer to check against
-     * @return
+     * @return <code>true</code> if the given ColorRGBA is equal to the data stored in the buffer at the given data
+     *         index
      */
     public static boolean equals(final ReadOnlyColorRGBA check, final FloatBuffer buf, final int index) {
         final ColorRGBA temp = new ColorRGBA();
@@ -230,6 +234,7 @@ public final class BufferUtils {
      *
      * @param data
      *            array of Vector4 objects to place into a new FloatBuffer
+     * @return the requested new FloatBuffer
      */
     public static FloatBuffer createFloatBuffer(final ReadOnlyVector4... data) {
         if (data == null) {
@@ -248,6 +253,7 @@ public final class BufferUtils {
      *            the number of vectors to read
      * @param data
      *            array of Vector4 objects to place into a new FloatBuffer
+     * @return the requested new FloatBuffer
      */
     public static FloatBuffer createFloatBuffer(final int offset, final int length, final ReadOnlyVector4... data) {
         if (data == null) {
@@ -468,7 +474,7 @@ public final class BufferUtils {
      *            the buffer to compare data with
      * @param index
      *            the position (in terms of vectors, not floats) of the vector in the buffer to check against
-     * @return
+     * @return <code>true</code> if the given Vector3 is equals to the data stored in the buffer at the given data index
      */
     public static boolean equals(final ReadOnlyVector4 check, final FloatBuffer buf, final int index) {
         final Vector4 temp = Vector4.fetchTempInstance();
@@ -486,6 +492,8 @@ public final class BufferUtils {
      *
      * @param data
      *            array of Vector3 objects to place into a new FloatBuffer
+     *
+     * @return the requested new FloatBuffer
      */
     public static FloatBuffer createFloatBuffer(final ReadOnlyVector3... data) {
         if (data == null) {
@@ -504,6 +512,7 @@ public final class BufferUtils {
      *            the number of vectors to read
      * @param data
      *            array of Vector3 objects to place into a new FloatBuffer
+     * @return the requested new FloatBuffer
      */
     public static FloatBuffer createFloatBuffer(final int offset, final int length, final ReadOnlyVector3... data) {
         if (data == null) {
@@ -718,7 +727,7 @@ public final class BufferUtils {
      *            the buffer to compare data with
      * @param index
      *            the position (in terms of vectors, not floats) of the vector in the buffer to check against
-     * @return
+     * @return <code>true</code> if the given Vector3 is equals to the data stored in the buffer at the given data index
      */
     public static boolean equals(final ReadOnlyVector3 check, final FloatBuffer buf, final int index) {
         final Vector3 temp = Vector3.fetchTempInstance();
@@ -736,6 +745,7 @@ public final class BufferUtils {
      *
      * @param data
      *            array of Vector2 objects to place into a new FloatBuffer
+     * @return the requested new FloatBuffer
      */
     public static FloatBuffer createFloatBuffer(final ReadOnlyVector2... data) {
         if (data == null) {
@@ -754,6 +764,7 @@ public final class BufferUtils {
      *            the number of vectors to read
      * @param data
      *            array of Vector2 objects to place into a new FloatBuffer
+     * @return the requested new FloatBuffer
      */
     public static FloatBuffer createFloatBuffer(final int offset, final int length, final ReadOnlyVector2... data) {
         if (data == null) {
@@ -954,7 +965,7 @@ public final class BufferUtils {
      *            the buffer to compare data with
      * @param index
      *            the position (in terms of vectors, not floats) of the vector in the buffer to check against
-     * @return
+     * @return <code>true</code> if the given Vector2 is equals to the data stored in the buffer at the given data index
      */
     public static boolean equals(final ReadOnlyVector2 check, final FloatBuffer buf, final int index) {
         final Vector2 temp = Vector2.fetchTempInstance();
@@ -972,6 +983,7 @@ public final class BufferUtils {
      *
      * @param data
      *            array of ints to place into a new IntBuffer
+     * @return the requested new IntBuffer
      */
     public static IntBuffer createIntBuffer(final int... data) {
         if (data == null) {
@@ -1154,6 +1166,7 @@ public final class BufferUtils {
      *
      * @param data
      *            array of float primitives to place into a new FloatBuffer
+     * @return the new FloatBuffer
      */
     public static FloatBuffer createFloatBuffer(final float... data) {
         return createFloatBuffer(null, data);
@@ -1162,8 +1175,12 @@ public final class BufferUtils {
     /**
      * Generate a new FloatBuffer using the given array of float primitives.
      *
+     * @param reuseStore
+     *            the store reused if non null and big enough to contain the float primitives
+     *
      * @param data
      *            array of float primitives to place into a new FloatBuffer
+     * @return the new FloatBuffer
      */
     public static FloatBuffer createFloatBuffer(final FloatBuffer reuseStore, final float... data) {
         if (data == null) {
@@ -1192,6 +1209,7 @@ public final class BufferUtils {
      *            the number of vectors to read
      * @param data
      *            array of Vector2 objects to place into a new FloatBuffer
+     * @return the new FloatBuffer created on the heap
      */
     public static FloatBuffer createFloatBufferOnHeap(final int offset, final int length,
             final ReadOnlyVector2... data) {
@@ -1220,6 +1238,7 @@ public final class BufferUtils {
      *            the number of vectors to read
      * @param data
      *            array of Vector3 objects to place into a new FloatBuffer
+     * @return the new FloatBuffer created on the heap
      */
     public static FloatBuffer createFloatBufferOnHeap(final int offset, final int length,
             final ReadOnlyVector3... data) {
@@ -1248,6 +1267,7 @@ public final class BufferUtils {
      *            the number of colors to read
      * @param data
      *            array of ColorRGBA objects to place into a new FloatBuffer
+     * @return the new FloatBuffer created on the heap
      */
     public static FloatBuffer createFloatBufferOnHeap(final int offset, final int length,
             final ReadOnlyColorRGBA... data) {
@@ -1528,6 +1548,7 @@ public final class BufferUtils {
      *
      * @param data
      *            array of short primitives to place into a new ShortBuffer
+     * @return the new ShortBuffer
      */
     public static ShortBuffer createShortBuffer(final short... data) {
         if (data == null) {