Javadoc cleanup

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

engine/src/android/com/jme3/renderer/android/OGLESShaderRenderer.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2010 jMonkeyEngine
+ * Copyright (c) 2009-2012 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -1460,10 +1460,9 @@ public class OGLESShaderRenderer implements Renderer {
     }
 
     /**
-     * <code>updateTexImageData</code> activates and binds the texture
+     * activates and binds the texture
      * @param img
      * @param type
-     * @param needMips
      */
     public void updateTexImageData(Image img, Texture.Type type) {
         int texId = img.getId();

engine/src/blender/com/jme3/scene/plugins/blender/constraints/definitions/ConstraintDefinitionFactory.java

@@ -46,10 +46,6 @@ public class ConstraintDefinitionFactory {
 	 * 
 	 * @param constraintStructure
 	 *            the constraint's structure (bConstraint clss in blender 2.49). If the value is null the NullConstraint is created.
-	 * @param ownerOMA
-	 *            the old memory address of the constraint's owner
-	 * @param influenceIpo
-	 *            the ipo curve of the influence factor
 	 * @param blenderContext
 	 *            the blender context
 	 * @throws BlenderFileException

engine/src/blender/com/jme3/scene/plugins/blender/curves/CurvesHelper.java

@@ -366,8 +366,6 @@ public class CurvesHelper extends AbstractBlenderHelper {
      *            the taper curve length
      * @param percent
      *            the percent of way along the whole taper curve
-     * @param store
-     *            the vector where the result will be stored
      */
     protected float getTaperScale(float[] taperPoints, float taperLength, float percent) {
         float length = taperLength * percent;

engine/src/blender/com/jme3/scene/plugins/blender/textures/ColorBand.java

@@ -31,9 +31,8 @@ public class ColorBand {
 
 	/**
 	 * Constructor. Loads the data from the given structure.
-	 * 
+         * @param tex
-	 * @param cbdataStructure
+         * @param blenderContext 
-	 *            the colorband structure
          */
 	@SuppressWarnings("unchecked")
 	public ColorBand(Structure tex, BlenderContext blenderContext) {

engine/src/blender/com/jme3/scene/plugins/blender/textures/blending/TextureBlenderAWT.java

@@ -114,10 +114,6 @@ public class TextureBlenderAWT extends AbstractTextureBlender {
 	 *            the material color
 	 * @param pixelColor
 	 *            the pixel color
-	 * @param blendFactor
-	 *            the blending factor
-	 * @param blendtype
-	 *            the blending type
 	 * @param blenderContext
 	 *            the blender context
 	 */

engine/src/bullet-common/com/jme3/bullet/control/ragdoll/RagdollUtils.java

@@ -97,8 +97,11 @@ public class RagdollUtils {
     /**
      * Create a hull collision shape from linked vertices to this bone.
      * Vertices have to be previoulsly gathered in a map using buildPointMap method
-     * @param link
+     * 
-     * @param model
+     * @param pointsMap
+     * @param boneIndices
+     * @param initialScale
+     * @param initialPosition
      * @return 
      */
     public static HullCollisionShape makeShapeFromPointMap(Map<Integer, List<Float>> pointsMap, List<Integer> boneIndices, Vector3f initialScale, Vector3f initialPosition) {
@@ -149,8 +152,11 @@ public class RagdollUtils {
     /**
      * Create a hull collision shape from linked vertices to this bone.
      * 
-     * @param link
      * @param model
+     * @param boneIndices
+     * @param initialScale
+     * @param initialPosition
+     * @param weightThreshold
      * @return 
      */
     public static HullCollisionShape makeShapeFromVerticeWeights(Spatial model, List<Integer> boneIndices, Vector3f initialScale, Vector3f initialPosition, float weightThreshold) {

engine/src/core-effects/com/jme3/post/filters/BloomFilter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2010 jMonkeyEngine
+ * Copyright (c) 2009-2012 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -237,7 +237,7 @@ public class BloomFilter extends Filter {
 
     /**
      * returns the exposure cutoff<br>
-     * for more details see {@link setExposureCutOff(float exposureCutOff)}
+     * for more details see {@link #setExposureCutOff(float exposureCutOff)}
      * @return 
      */    
     public float getExposureCutOff() {
@@ -254,7 +254,7 @@ public class BloomFilter extends Filter {
 
     /**
      * returns the exposure power<br>
-     * form more details see {@link setExposurePower(float exposurePower)}
+     * form more details see {@link #setExposurePower(float exposurePower)}
      * @return 
      */
     public float getExposurePower() {
@@ -272,7 +272,7 @@ public class BloomFilter extends Filter {
 
     /**
      * returns the downSampling factor<br>
-     * form more details see {@link setDownSamplingFactor(float downSamplingFactor)}
+     * form more details see {@link #setDownSamplingFactor(float downSamplingFactor)}
      * @return
      */
     public float getDownSamplingFactor() {

engine/src/core-effects/com/jme3/post/filters/CartoonEdgeFilter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2010 jMonkeyEngine
+ * Copyright (c) 2009-2012 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -107,7 +107,7 @@ public class CartoonEdgeFilter extends Filter {
 
     /**
      * Return the depth sensitivity<br>
-     * for more details see {@link setDepthSensitivity(float depthSensitivity)}
+     * for more details see {@link #setDepthSensitivity(float depthSensitivity)}
      * @return 
      */
     public float getDepthSensitivity() {
@@ -128,7 +128,7 @@ public class CartoonEdgeFilter extends Filter {
 
     /**
      * returns the depth threshold<br>
-     * for more details see {@link setDepthThreshold(float depthThreshold)}
+     * for more details see {@link #setDepthThreshold(float depthThreshold)}
      * @return 
      */
     public float getDepthThreshold() {
@@ -149,7 +149,7 @@ public class CartoonEdgeFilter extends Filter {
 
     /**
      * returns the edge intensity<br>
-     * for more details see {@link setEdgeIntensity(float edgeIntensity) }
+     * for more details see {@link #setEdgeIntensity(float edgeIntensity) }
      * @return 
      */
     public float getEdgeIntensity() {
@@ -190,7 +190,7 @@ public class CartoonEdgeFilter extends Filter {
 
     /**
      * returns the normals sensitivity<br>
-     * form more details see {@link setNormalSensitivity(float normalSensitivity)}
+     * form more details see {@link #setNormalSensitivity(float normalSensitivity)}
      * @return 
      */
     public float getNormalSensitivity() {
@@ -210,7 +210,7 @@ public class CartoonEdgeFilter extends Filter {
 
     /**
      * returns the normal threshold<br>
-     * for more details see {@link setNormalThreshold(float normalThreshold)}
+     * for more details see {@link #setNormalThreshold(float normalThreshold)}
      * 
      * @return 
      */

engine/src/core-effects/com/jme3/post/filters/LightScatteringFilter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2010 jMonkeyEngine
+ * Copyright (c) 2009-2012 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -136,7 +136,7 @@ public class LightScatteringFilter extends Filter {
 
     /**
      * returns the blur start of the scattering 
-     * see {@link  setBlurStart(float blurStart)}
+     * see {@link #setBlurStart(float blurStart)}
      * @return 
      */
     public float getBlurStart() {
@@ -154,7 +154,7 @@ public class LightScatteringFilter extends Filter {
 
     /**
      * returns the blur width<br>
-     * see {@link setBlurWidth(float blurWidth)}
+     * see {@link #setBlurWidth(float blurWidth)}
      * @return 
      */
     public float getBlurWidth() {
@@ -170,8 +170,8 @@ public class LightScatteringFilter extends Filter {
     }
 
     /**
-     * retiurns the light density<br>
+     * returns the light density
-     * see {@link setLightDensity(float lightDensity)}
+     * see {@link #setLightDensity(float lightDensity)}
      * 
      * @return 
      */

engine/src/core-effects/com/jme3/post/filters/PosterizationFilter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2010 jMonkeyEngine
+ * Copyright (c) 2009-2012 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -47,7 +47,7 @@ import com.jme3.renderer.ViewPort;
  * Based on an article from Geeks3D:
  *    <a href="http://www.geeks3d.com/20091027/shader-library-posterization-post-processing-effect-glsl/" rel="nofollow">http://www.geeks3d.com/20091027/shader-library-posterization-post-processing-effect-glsl/</a>
  *
- * @author: Roy Straver a.k.a. Baal Garnaal
+ * @author Roy Straver a.k.a. Baal Garnaal
  */
 public class PosterizationFilter extends Filter {
 

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

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2011 jMonkeyEngine
+ * Copyright (c) 2009-2012 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -113,9 +113,8 @@ public class Animation implements Savable, Cloneable {
 
     /**
      * Set the {@link Track}s to be used by this animation.
-     * <p>
      * 
-     * @param tracks The tracks to set.
+     * @param tracksArray The tracks to set.
      */
     public void setTracks(Track[] tracksArray) {
         for (Track track : tracksArray) {

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

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2011 jMonkeyEngine
+ * Copyright (c) 2009-2012 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -221,7 +221,7 @@ public class AnimationFactory {
     /**
      * Adds a key frame for the given rotation at the given time<br>
      * This can't be used if the interpolated angle is higher than PI (180°)<br>
-     * Use {@link addTimeRotationAngles(float time, float x, float y, float z)}  instead that uses Euler angles rotations.<br>     * 
+     * Use {@link #addTimeRotationAngles(float time, float x, float y, float z)}  instead that uses Euler angles rotations.<br>     * 
      * @param time the time at which the keyFrame must be inserted
      * @param rotation the rotation Quaternion to use for this keyFrame
      * @see #addTimeRotationAngles(float time, float x, float y, float z) 
@@ -233,7 +233,7 @@ public class AnimationFactory {
     /**
      * Adds a key frame for the given rotation at the given keyFrame index<br>
      * This can't be used if the interpolated angle is higher than PI (180°)<br>
-     * Use {@link addKeyFrameRotationAngles(int keyFrameIndex, float x, float y, float z)} instead that uses Euler angles rotations.
+     * Use {@link #addKeyFrameRotationAngles(int keyFrameIndex, float x, float y, float z)} instead that uses Euler angles rotations.
      * @param keyFrameIndex the index at which the keyFrame must be inserted
      * @param rotation the rotation Quaternion to use for this keyFrame
      * @see #addKeyFrameRotationAngles(int keyFrameIndex, float x, float y, float z) 

engine/src/core/com/jme3/export/SavableClassUtil.java

@@ -157,7 +157,6 @@ public class SavableClassUtil {
      * are checked to handle special cases, if the modules do not handle the class name, the
      * class is instantiated directly. 
      * @param className the class name to create.
-     * @param inputCapsule the InputCapsule that will be used for loading the Savable (to look up ctor parameters)
      * @return the Savable instance of the class.
      * @throws InstantiationException thrown if the class does not have an empty constructor.
      * @throws IllegalAccessException thrown if the class is not accessable.

engine/src/core/com/jme3/input/ChaseCamera.java

@@ -525,7 +525,6 @@ public class ChaseCamera implements ActionListener, AnalogListener, Control {
 
     /**
      * Sets the min zoom distance of the camera (default is 1)
-     * @return minDistance
      */
     public void setMinDistance(float minDistance) {
         this.minDistance = minDistance;

engine/src/core/com/jme3/material/TechniqueDef.java

@@ -234,7 +234,8 @@ public class TechniqueDef implements Savable {
      * 
      * @param vertexShader The name of the vertex shader
      * @param fragmentShader The name of the fragment shader
-     * @param shaderLanguage The shader language
+     * @param vertLanguage The vertex shader language
+     * @param fragLanguage The fragment shader language
      */
     public void setShaderFile(String vertexShader, String fragmentShader, String vertLanguage, String fragLanguage){
         this.vertName = vertexShader;

engine/src/core/com/jme3/post/Filter.java

@@ -289,8 +289,7 @@ public abstract class Filter implements Savable {
 
     /**
      * Override this method if you want to make a pre pass, before the actual rendering of the frame
-     * @param renderManager
+     * @param queue
-     * @param viewPort
      */
     protected void postQueue(RenderQueue queue) {
     }

engine/src/core/com/jme3/renderer/Renderer.java

@@ -285,7 +285,7 @@ public interface Renderer {
      * then resets the native objects.
      * 
      * @see #resetGLObjects() 
-     * @see NativeObject#deleteObject(com.jme3.renderer.Renderer) 
+     * @see NativeObject#deleteObject(java.lang.Object) 
      */
     public void cleanup();
     

engine/src/core/com/jme3/scene/Mesh.java

@@ -434,8 +434,6 @@ public class Mesh implements Savable, Cloneable {
 
     /**
      * Get the mode start indices for {@link Mode#Hybrid} mesh mode.
-     * 
-     * @return mode start indices
      */
     public void setModeStart(int[] modeStart) {
         this.modeStart = modeStart;

engine/src/core/com/jme3/shadow/PssmShadowFilter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2010 jMonkeyEngine
+ * Copyright (c) 2009-2012 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -138,8 +138,8 @@ public class PssmShadowFilter extends Filter {
     }
 
     /**
-     * returns the labda parameter<br>
+     * returns the labda parameter
-     * see {@link setLambda(float lambda)}
+     * @see #setLambda(float lambda)
      * @return lambda
      */
     public float getLambda() {
@@ -160,7 +160,7 @@ public class PssmShadowFilter extends Filter {
 
     /**
      * How far the shadows are rendered in the view
-     * see {@link setShadowZExtend(float zFar)}
+     * @see setShadowZExtend(float zFar)
      * @return shadowZExtend
      */
     public float getShadowZExtend() {
@@ -177,8 +177,8 @@ public class PssmShadowFilter extends Filter {
     }
 
     /**
-     * returns the shdaow intensity<br>
+     * returns the shdaow intensity
-     * see {@link setShadowIntensity(float shadowIntensity)}
+     * @see #setShadowIntensity(float shadowIntensity)
      * @return shadowIntensity
      */
     public float getShadowIntensity() {
@@ -198,7 +198,7 @@ public class PssmShadowFilter extends Filter {
 
     /**
      * returns the edges thickness <br>
-     * see {@link setEdgesThickness(int edgesThickness)}
+     * @see #setEdgesThickness(int edgesThickness)
      * @return edgesThickness
      */
     public int getEdgesThickness() {

engine/src/core/com/jme3/shadow/PssmShadowRenderer.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2010 jMonkeyEngine All rights reserved.
+ * Copyright (c) 2009-2012 jMonkeyEngine All rights reserved.
  * <p/>
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
@@ -179,7 +179,6 @@ public class PssmShadowRenderer implements SceneProcessor {
      * @param manager the application asset manager
      * @param size the size of the rendered shadowmaps (512,1024,2048, etc...)
      * @param nbSplits the number of shadow maps rendered (the more shadow maps the more quality, the less fps). 
-     * @param filterPass set this to true if you want the post shadow pass to be done in a Filter un screen space.
      * @param postShadowMat the material used for post shadows if you need to override it          
      */
     protected PssmShadowRenderer(AssetManager manager, int size, int nbSplits, Material postShadowMat) {
@@ -568,8 +567,8 @@ public class PssmShadowRenderer implements SceneProcessor {
     }
 
     /**
-     * returns the labda parameter<br>
+     * returns the labda parameter
-     * see {@link setLambda(float lambda)}
+     * see #setLambda(float lambda)
      * @return lambda
      */
     public float getLambda() {
@@ -590,7 +589,7 @@ public class PssmShadowRenderer implements SceneProcessor {
 
     /**
      * How far the shadows are rendered in the view
-     * see {@link setShadowZExtend(float zFar)}
+     * @see #setShadowZExtend(float zFar)
      * @return shadowZExtend
      */
     public float getShadowZExtend() {
@@ -607,8 +606,8 @@ public class PssmShadowRenderer implements SceneProcessor {
     }
 
     /**
-     * returns the shdaow intensity<br>
+     * returns the shdaow intensity
-     * see {@link setShadowIntensity(float shadowIntensity)}
+     * @see #setShadowIntensity(float shadowIntensity)
      * @return shadowIntensity
      */
     public float getShadowIntensity() {
@@ -629,8 +628,8 @@ public class PssmShadowRenderer implements SceneProcessor {
     }
 
     /**
-     * returns the edges thickness <br>
+     * returns the edges thickness
-     * see {@link setEdgesThickness(int edgesThickness)}
+     * @see #setEdgesThickness(int edgesThickness)
      * @return edgesThickness
      */
     public int getEdgesThickness() {

engine/src/core/com/jme3/texture/image/ImageRaster.java

@@ -1,10 +1,8 @@
 package com.jme3.texture.image;
 
 import com.jme3.math.ColorRGBA;
-import com.jme3.math.FastMath;
 import com.jme3.system.JmeSystem;
 import com.jme3.texture.Image;
-import java.nio.ByteBuffer;
 
 /**
  * Utility class for reading and writing from jME3 {@link Image images}.

engine/src/desktop/jme3tools/navigation/NavCalculator.java

@@ -1,7 +1,3 @@
-/*
- * To change this template, choose Tools | Templates
- * and open the template in the editor.
- */
 package jme3tools.navigation;
 
 

engine/src/lwjgl/com/jme3/renderer/lwjgl/LwjglRenderer.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2010 jMonkeyEngine
+ * Copyright (c) 2009-2012 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -1780,7 +1780,6 @@ public class LwjglRenderer implements Renderer {
      * 
      * @param img The image to upload
      * @param type How the data in the image argument should be interpreted.
-     * @param updateMipsOnly If true, then texture data is already updated for this image, only 
      * @param unit The texture slot to be used to upload the image, not important
      */
     public void updateTexImageData(Image img, Texture.Type type, int unit) {

engine/src/terrain/com/jme3/terrain/geomipmap/LODGeomap.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2010 jMonkeyEngine
+ * Copyright (c) 2009-2012 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -1047,8 +1047,6 @@ public class LODGeomap extends GeoMap {
      *
      * @param x local x coordinate
      * @param z local z coordinate
-     * @param scale
-     * @param translation
      * @return
      */
     protected Triangle[] getGridTrianglesAtPoint(float x, float z) {

engine/src/terrain/com/jme3/terrain/geomipmap/picking/BresenhamTerrainPicker.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2010 jMonkeyEngine
+ * Copyright (c) 2009-2012 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -189,8 +189,8 @@ public class BresenhamTerrainPicker implements TerrainPicker {
      *            grid row
      * @param gridY
      *            grid column
-     * @param block
+     * @param patch
-     *            the TerrainBlock we are working with
+     *            the TerrainPatch we are working with
      * @return true if the grid point is valid for the given block, false if it
      *         is off the block.
      */
@@ -222,8 +222,8 @@ public class BresenhamTerrainPicker implements TerrainPicker {
      *
      * @param position
      *            the position to check at
-     * @param block
+     * @param patch
-     *            the block to get height values from
+     *            the patch to get height values from
      * @return an index to the height position of the given block.
      */
     protected int findClosestHeightIndex(Vector3f position, TerrainPatch patch) {