Brought the number of Javadoc workings down to 322 from 391; Updated year to 2012 in license header of affected files

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

engine/src/blender/com/jme3/asset/BlenderKey.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
@@ -244,7 +244,7 @@ public class BlenderKey extends ModelKey {
 
 	/**
 	 * This method removes features from being loaded.
-	 * @param featuresToLoad
+	 * @param featuresNotToLoad
 	 *        bitwise flag of FeaturesToLoad interface values
 	 */
 	public void excludeFromLoading(int featuresNotToLoad) {

engine/src/blender/com/jme3/scene/plugins/blender/BlenderContext.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
@@ -383,10 +383,8 @@ public class BlenderContext {
 	/**
 	 * This method removes the ipo curve from the feature.
 	 * 
-	 * @param ownerOMA
+	 * @param ownerOma
 	 *            the OMA of blender feature that owns the ipo
-	 * @param ipo
-	 *            the ipo that was just removed
 	 */
 	public Ipo removeIpo(Long ownerOma) {
 		return loadedIpos.remove(ownerOma);
@@ -397,8 +395,6 @@ public class BlenderContext {
 	 * 
 	 * @param ownerOMA
 	 *            the OMA of blender feature that owns the ipo
-	 * @param ipo
-	 *            the ipo that belongs to the specified owner
 	 */
 	public Ipo getIpo(Long ownerOMA) {
 		return loadedIpos.get(ownerOMA);
@@ -503,7 +499,7 @@ public class BlenderContext {
 	 * 
 	 * @param skeletonOMA
 	 *            the skeleton's old memory address
-	 * @param animData
+	 * @param skeleton
 	 *            the skeleton specified by the given OMA
 	 */
 	public void setSkeleton(Long skeletonOMA, Skeleton skeleton) {

engine/src/blender/com/jme3/scene/plugins/blender/file/BlenderInputStream.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
@@ -76,8 +76,6 @@ public class BlenderInputStream extends InputStream {
      *        the stream we read data from
      * @param assetManager
      *        the application's asset manager
-     * @param endianess
-     *        type of byte ordering used; 'v' means little endian and 'V' means big endian
      * @throws BlenderFileException
      *         this exception is thrown if the file header has some invalid data
      */

engine/src/blender/com/jme3/scene/plugins/blender/file/Pointer.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
@@ -80,8 +80,6 @@ public class Pointer {
      * This method fetches the data stored under the given address.
      * @param inputStream
      *        the stream we read data from
-     * @param dataIndices
-     *        the offset of the data in the table pointed by the pointer
      * @return the data read from the file
      * @throws BlenderFileException
      *         this exception is thrown when the blend file structure is somehow invalid or corrupted

engine/src/blender/com/jme3/scene/plugins/blender/materials/MaterialHelper.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
@@ -463,8 +463,12 @@ public class MaterialHelper extends AbstractBlenderHelper {
 	/**
 	 * This method converts rgb values to hsv values.
 	 * 
-	 * @param rgb
+	 * @param r
-	 *        rgb values of the color
+	 *        red value of the color
+         * @param g
+         *        green value of the color
+         * @param b
+         *        blue value of the color
 	 * @param hsv
 	 *        hsv values of a color (this table contains the result of the transformation)
 	 */

engine/src/blender/com/jme3/scene/plugins/blender/modifiers/ModifierHelper.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
@@ -68,8 +68,6 @@ public class ModifierHelper extends AbstractBlenderHelper {
      *        the object structure
      * @param blenderContext
      *        the blender context
-     * @param converter
-     *        the converter object (in some cases we need to read an object first before loading the modifier)
      * @throws BlenderFileException
      *         this exception is thrown when the blender file is somehow corrupted
      */

engine/src/bullet-common/com/jme3/bullet/control/RigidBodyControl.java

@@ -52,7 +52,6 @@ public class RigidBodyControl extends PhysicsRigidBody implements PhysicsControl
 
     /**
      * Creates a new PhysicsNode with the supplied collision shape and mass 1
-     * @param child
      * @param shape
      */
     public RigidBodyControl(CollisionShape shape) {

engine/src/bullet-common/com/jme3/bullet/control/VehicleControl.java

@@ -40,7 +40,6 @@ public class VehicleControl extends PhysicsVehicle implements PhysicsControl {
 
     /**
      * Creates a new PhysicsNode with the supplied collision shape
-     * @param child
      * @param shape
      */
     public VehicleControl(CollisionShape shape) {

engine/src/core/com/jme3/animation/BoneTrack.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
@@ -182,8 +182,10 @@ public final class BoneTrack implements Track {
      * The transforms can be interpolated in some method from the keyframes.
      *
      * @param time the current time of the animation
-     * @param skeleton the skeleton to which the bone belong
      * @param weight the weight of the animation
+     * @param control
+     * @param channel
+     * @param vars
      */
     public void setTime(float time, float weight, AnimControl control, AnimChannel channel, TempVars vars) {
         BitSet affectedBones = channel.getAffectedBones();

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

@@ -64,8 +64,6 @@ public class SpatialTrack implements Track {
      * 
      * @param time
      *            the current time of the animation
-     * @param spatial
-     *            the spatial that should be animated with this track
      */
     public void setTime(float time, float weight, AnimControl control, AnimChannel channel, TempVars vars) {
         Spatial spatial = control.getSpatial();

engine/src/core/com/jme3/asset/ImplHandler.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
@@ -112,7 +112,7 @@ public class ImplHandler {
      * gets a hint that it should suppress {@link AssetNotFoundException}s
      * and instead call the listener callback (if set).
      * 
-     * @param key The parent key  
+     * @param parentKey The parent key  
      */
     public void establishParentKey(AssetKey parentKey){
         if (parentAssetKey.get() == null){
@@ -132,7 +132,7 @@ public class ImplHandler {
     
     /**
      * Attempts to locate the given resource name.
-     * @param name The full name of the resource.
+     * @param key The full name of the resource.
      * @return The AssetInfo containing resource information required for
      * access, or null if not found.
      */

engine/src/core/com/jme3/bounding/BoundingVolume.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

engine/src/core/com/jme3/cinematic/events/CinematicEvent.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
@@ -83,7 +83,7 @@ public interface CinematicEvent extends Savable {
     public PlayState getPlayState();
 
     /**
-     * @param loopMode Set the loop mode for the channel. The loop mode
+     * @param loop Set the loop mode for the channel. The loop mode
      * determines what will happen to the animation once it finishes
      * playing.
      *

engine/src/core/com/jme3/effect/ParticleEmitter.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
@@ -591,7 +591,9 @@ public class ParticleEmitter extends Geometry {
     /**
      * Sets the gravity vector.
      * 
-     * @param gravity the gravity vector
+     * @param x the x component of the gravity vector
+     * @param y the y component of the gravity vector
+     * @param z the z component of the gravity vector
      */
     public void setGravity(float x, float y, float z) {
         this.gravity.x = x;

engine/src/core/com/jme3/input/ChaseCamera.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
@@ -857,7 +857,7 @@ public class ChaseCamera implements ActionListener, AnalogListener, Control {
 
     /**
      * invert the Horizontal axis movement of the mouse
-     * @param invertYaxis
+     * @param invertXaxis
      */
     public void setInvertHorizontalAxis(boolean invertXaxis) {
         this.invertXaxis = invertXaxis;

engine/src/core/com/jme3/input/FlyByCamera.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
@@ -148,7 +148,7 @@ public class FlyByCamera implements AnalogListener, ActionListener {
     /**
      * Registers the FlyByCamera to receive input events from the provided
      * Dispatcher.
-     * @param dispacher
+     * @param inputManager
      */
     public void registerWithInput(InputManager inputManager){
         this.inputManager = inputManager;

engine/src/core/com/jme3/input/InputManager.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
@@ -122,9 +122,10 @@ public class InputManager implements RawInputListener {
      * 
      * <p>This should only be called internally in {@link Application}.
      *
-     * @param mouseInput
+     * @param mouse
-     * @param keyInput
+     * @param keys
-     * @param joyInput
+     * @param joystick
+     * @param touch
      * @throws IllegalArgumentException If either mouseInput or keyInput are null.
      */
     public InputManager(MouseInput mouse, KeyInput keys, JoyInput joystick, TouchInput touch) {
@@ -614,7 +615,7 @@ public class InputManager implements RawInputListener {
      * 
      * <p>By default the cursor is visible.
      * 
-     * @param visible whether the mouse cursor is visible or not.
+     * @return whether the mouse cursor is visible or not.
      * 
      * @see InputManager#setCursorVisible(boolean) 
      */

engine/src/core/com/jme3/post/filters/CrossHatchFilter.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
@@ -46,7 +46,7 @@ import com.jme3.renderer.ViewPort;
  * Based on an article from Geeks3D:
  *    <a href="http://www.geeks3d.com/20110219/shader-library-crosshatching-glsl-filter/" rel="nofollow">http://www.geeks3d.com/20110219/shader-library-crosshatching-glsl-filter/</a>
  *
- * @author: Roy Straver a.k.a. Baal Garnaal
+ * @author Roy Straver a.k.a. Baal Garnaal
  */
 public class CrossHatchFilter extends Filter {
 

engine/src/core/com/jme3/post/filters/FogFilter.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
@@ -122,7 +122,7 @@ public class FogFilter extends Filter {
 
     /**
      * Sets the density of the fog, a high value gives a thick fog
-     * @param fogColor
+     * @param fogDensity
      */
     public void setFogDensity(float fogDensity) {
         if (material != null) {

engine/src/core/com/jme3/post/filters/RadialBlurFilter.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
@@ -100,7 +100,7 @@ public class RadialBlurFilter extends Filter {
     /**
      * 
      * @return 
-     * @deprecated use {@link getSampleDistance()}
+     * @deprecated use {@link #getSampleDistance()}
      */
     @Deprecated
     public float getSampleDist() {
@@ -110,7 +110,7 @@ public class RadialBlurFilter extends Filter {
     /**
      * 
      * @param sampleDist
-     * @deprecated use {@link setSampleDistance(float sampleDist)}
+     * @deprecated use {@link #setSampleDistance(float sampleDist)}
      */
     @Deprecated
     public void setSampleDist(float sampleDist) {

engine/src/core/com/jme3/post/ssao/SSAOFilter.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
@@ -185,7 +185,7 @@ public class SSAOFilter extends Filter {
 
     /**
      * Return the bias<br>
-     * see {@link  setBias(float bias)}
+     * see {@link  #setBias(float bias)}
      * @return 
      */
     public float getBias() {
@@ -246,7 +246,7 @@ public class SSAOFilter extends Filter {
 
     /**
      * returns the scale<br>
-     * see {@link setScale(float scale)}
+     * see {@link #setScale(float scale)}
      * @return 
      */
     public float getScale() {
@@ -275,7 +275,6 @@ public class SSAOFilter extends Filter {
 
     /**
      * debugging only , will be removed
-     * @return 
      */
     public void setUseAo(boolean useAo) {
         this.useAo = useAo;
@@ -295,7 +294,6 @@ public class SSAOFilter extends Filter {
 
     /**
      * debugging only , will be removed
-     * @return 
      */
     public void setUseOnlyAo(boolean useOnlyAo) {
         this.useOnlyAo = useOnlyAo;

engine/src/core/com/jme3/renderer/Caps.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
@@ -328,7 +328,7 @@ public enum Caps {
      * can be supported by the renderer.
      * 
      * @param caps The collection of renderer capabilities {@link Renderer#getCaps() }.
-     * @param fb The shader to check
+     * @param shader The shader to check
      * @return True if it is supported, false otherwise.
      */
     public static boolean supports(Collection<Caps> caps, Shader shader){

engine/src/core/com/jme3/renderer/RenderManager.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
@@ -152,7 +152,7 @@ public class RenderManager {
     /**
      * Removes the main ViewPort with the specified name.
      * 
-     * @param view The main ViewPort name to remove
+     * @param viewName The main ViewPort name to remove
      * @return True if the ViewPort was removed successfully.
      * 
      * @see #createMainView(java.lang.String, com.jme3.renderer.Camera) 
@@ -199,7 +199,7 @@ public class RenderManager {
     /**
      * Removes the post ViewPort with the specified name.
      * 
-     * @param view The post ViewPort name to remove
+     * @param viewName The post ViewPort name to remove
      * @return True if the ViewPort was removed successfully.
      * 
      * @see #createPostView(java.lang.String, com.jme3.renderer.Camera) 

engine/src/core/com/jme3/renderer/ViewPort.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
@@ -182,7 +182,7 @@ public class ViewPort {
      * <p>
      * By default color clearing is disabled.
      * 
-     * @param clearDepth Enable/disable color buffer clearing.
+     * @param clearColor Enable/disable color buffer clearing.
      */
     public void setClearColor(boolean clearColor) {
         this.clearColor = clearColor;
@@ -204,7 +204,7 @@ public class ViewPort {
      * <p>
      * By default stencil clearing is disabled.
      * 
-     * @param clearDepth Enable/disable stencil buffer clearing.
+     * @param clearStencil Enable/disable stencil buffer clearing.
      */
     public void setClearStencil(boolean clearStencil) {
         this.clearStencil = clearStencil;

engine/src/core/com/jme3/scene/BatchNode.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

engine/src/core/com/jme3/scene/Mesh.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
@@ -1003,7 +1003,6 @@ public class Mesh implements Savable, Cloneable {
      * Acquires an index buffer that will read the vertices on the mesh
      * as a list.
      * 
-     * @param mesh The mesh to read from
      * @return A virtual or wrapped index buffer to read the data as a list
      */
     public IndexBuffer getIndicesAsList(){

engine/src/core/com/jme3/scene/shape/PQTorus.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
@@ -68,7 +68,6 @@ public class PQTorus extends Mesh {
      * <p>
      * Steps and radialSamples are both degree of accuracy values.
      * 
-     * @param name the name of the torus.
      * @param p the x/z oscillation.
      * @param q the y oscillation.
      * @param radius the radius of the PQTorus.

engine/src/core/com/jme3/shadow/ShadowUtil.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
@@ -271,8 +271,7 @@ public class ShadowUtil {
      * Updates the shadow camera to properly contain the given
      * points (which contain the eye camera frustum corners)
      *
-     * @param occluders
+     * @param shadowCam
-     * @param lightCam
      * @param points
      */
     public static void updateShadowCamera(Camera shadowCam, Vector3f[] points) {
@@ -325,7 +324,8 @@ public class ShadowUtil {
      * shadow occluder objects.
      *
      * @param occluders
-     * @param lightCam
+     * @param receivers
+     * @param shadowCam
      * @param points
      */
     public static void updateShadowCamera(GeometryList occluders,
@@ -341,7 +341,7 @@ public class ShadowUtil {
      * shadow occluder objects.
      * 
      * @param occluders
-     * @param lightCam
+     * @param shadowCam
      * @param points
      */
     public static void updateShadowCamera(GeometryList occluders,

engine/src/core/com/jme3/system/AppSettings.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
@@ -539,7 +539,7 @@ public final class AppSettings extends HashMap<String, Object> {
     /**
      * Enable 3D stereo.
      * <p>This feature requires hardware support from the GPU driver. 
-     * @see <a href="http://en.wikipedia.org/wiki/Quad_buffering">http://en.wikipedia.org/wiki/Quad_buffering</a><br>
+     * @see <a href="http://en.wikipedia.org/wiki/Quad_buffering">http://en.wikipedia.org/wiki/Quad_buffering</a><br />
      * Once enabled, filters or scene processors that handle 3D stereo rendering
      * could use this feature to render using hardware 3D stereo.</p>
      * (Default: false)

engine/src/core/com/jme3/water/WaterFilter.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
@@ -766,7 +766,7 @@ public class WaterFilter extends Filter {
      * Sets the color of the water
      * see setDeepWaterColor for deep water color
      * default is (0.0078f, 0.5176f, 0.5f,1.0f) (greenish blue)
-     * @param waterColour
+     * @param waterColor
      */
     public void setWaterColor(ColorRGBA waterColor) {
         this.waterColor = waterColor;

engine/src/desktop/com/jme3/app/SettingsDialog.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
@@ -117,7 +117,7 @@ public final class SettingsDialog extends JDialog {
      * @param imageFile
      *            the image file to use as the title of the dialog;
      *            <code>null</code> will result in to image being displayed
-     * @param mainThreadTasks 
+     * @param loadSettings 
      * @throws JmeException
      *             if the source is <code>null</code>
      */

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

@@ -142,8 +142,8 @@ public class NavCalculator {
     /**
      * Converts a course from cardinal XddY to ddd notation
      * @param tc
-     * @param dLong
+     * @param p1 position one
-     * @param dLat
+     * @param p2 position two
      * @return
      * @since 1.0
      */

engine/src/jbullet/com/jme3/bullet/collision/PhysicsCollisionObject.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
@@ -140,7 +140,7 @@ public abstract class PhysicsCollisionObject implements Savable {
 
     /**
      * Directly set the bitmask for collision groups that this object collides with.
-     * @param collisionGroup
+     * @param collisionGroups
      */
     public void setCollideWithGroups(int collisionGroups) {
         this.collisionGroupsMask = collisionGroups;

engine/src/jbullet/com/jme3/bullet/objects/PhysicsRigidBody.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
@@ -82,7 +82,6 @@ public class PhysicsRigidBody extends PhysicsCollisionObject {
 
     /**
      * Creates a new PhysicsRigidBody with the supplied collision shape
-     * @param child
      * @param shape
      */
     public PhysicsRigidBody(CollisionShape shape) {
@@ -181,7 +180,6 @@ public class PhysicsRigidBody extends PhysicsCollisionObject {
 
     /**
      * Gets the physics object location, instantiates a new Vector3f object
-     * @param location the location of the actual physics object is stored in this Vector3f
      */
     public Vector3f getPhysicsLocation() {
         return getPhysicsLocation(null);
@@ -189,7 +187,6 @@ public class PhysicsRigidBody extends PhysicsCollisionObject {
 
     /**
      * Gets the physics object rotation
-     * @param rotation the rotation of the actual physics object is stored in this Matrix3f
      */
     public Matrix3f getPhysicsRotationMatrix() {
         return getPhysicsRotationMatrix(null);
@@ -222,7 +219,6 @@ public class PhysicsRigidBody extends PhysicsCollisionObject {
     /**
      * Gets the physics object rotation as a quaternion, converts the bullet Matrix3f value,
      * instantiates new object
-     * @param rotation the rotation of the actual physics object is stored in this Quaternion
      */
     public Quaternion getPhysicsRotation(){
         return getPhysicsRotation(null);

engine/src/jbullet/com/jme3/bullet/objects/VehicleWheel.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
@@ -238,7 +238,7 @@ public class VehicleWheel implements Savable {
     /**
      * The maximum suspension force, raise this above the default 6000 if your suspension cannot
      * handle the weight of your vehcile.
-     * @param maxSuspensionTravelCm
+     * @param maxSuspensionForce
      */
     public void setMaxSuspensionForce(float maxSuspensionForce) {
         this.maxSuspensionForce = maxSuspensionForce;

engine/src/niftygui/com/jme3/niftygui/RenderFontJme.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
@@ -76,7 +76,7 @@ public class RenderFontJme implements RenderFont {
 
     /**
      * get font width of the given string.
-     * @param text text
+     * @param str text
      * @return width of the given text for the current font
      */
     public int getWidth(final String str) {

engine/src/ogre/com/jme3/scene/plugins/ogre/matext/OgreMaterialKey.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
@@ -56,7 +56,7 @@ public class OgreMaterialKey extends AssetKey<MaterialList> {
      * base materials to jME3 matdefs when loading.
      * Set to <code>null</code> to disable this functionality.
      *
-     * @param extension The {@link MaterialExtensionSet} to use
+     * @param matExts The {@link MaterialExtensionSet} to use
      */
     public void setMaterialExtensionSet(MaterialExtensionSet matExts){
         this.matExts = matExts;

engine/src/terrain/com/jme3/terrain/Terrain.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
@@ -131,7 +131,7 @@ public interface Terrain {
      * This is where the Terrain's LOD algorithm will change the detail of
      * the terrain based on how far away this position is from the particular
      * terrain patch.
-     * @param location: the Camera's location. A list of one camera location is normal 
+     * @param location the Camera's location. A list of one camera location is normal 
      *  if you just have one camera in your scene.
      */
     public void update(List<Vector3f> location, LodCalculator lodCalculator);

engine/src/terrain/com/jme3/terrain/geomipmap/TerrainPatch.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
@@ -268,8 +268,8 @@ public class TerrainPatch extends Geometry {
     
     /**
      * Get the triangle of this geometry at the specified local coordinate.
-     * @param gridX local to the terrain patch
+     * @param x local to the terrain patch
-     * @param gridY local to the terrain patch
+     * @param z local to the terrain patch
      * @return the triangle in world coordinates, or null if the point does intersect this patch on the XZ axis
      */
     public Triangle getTriangle(float x, float z) {
@@ -278,8 +278,8 @@ public class TerrainPatch extends Geometry {
 
     /**
      * Get the triangles at the specified grid point. Probably only 2 triangles
-     * @param gridX local to the terrain patch
+     * @param x local to the terrain patch
-     * @param gridY local to the terrain patch
+     * @param z local to the terrain patch
      * @return the triangles in world coordinates, or null if the point does intersect this patch on the XZ axis
      */
     public Triangle[] getGridTriangles(float x, float z) {

engine/src/terrain/com/jme3/terrain/heightmap/FaultHeightMap.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
@@ -96,7 +96,6 @@ public class FaultHeightMap extends AbstractHeightMap {
      * @param faultShape Shape of the fault -line or circle
      * @param minFaultHeight Height modified on each side
      * @param maxFaultHeight Height modified on each side
-     * @param faultHeight Height modified on each side
      * @param seed A seed to feed the Random generator
      * @see setFaultRange, setMinRadius, setMaxRadius
      */
@@ -122,7 +121,8 @@ public class FaultHeightMap extends AbstractHeightMap {
      * Create an heightmap with linear step faults.
      * @param size size of heightmap
      * @param iterations number of iterations
-     * @param faultHeight height to modify
+     * @param minFaultHeight Height modified on each side
+     * @param maxFaultHeight Height modified on each side
      */
     public FaultHeightMap(int size, int iterations, float minFaultHeight, float maxFaultHeight) throws Exception {
         this(size, iterations, FAULTTYPE_STEP, FAULTSHAPE_LINE, minFaultHeight, maxFaultHeight, new Random().nextLong());

engine/src/terrain/com/jme3/terrain/heightmap/HillHeightMap.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
@@ -63,8 +63,6 @@ public class HillHeightMap extends AbstractHeightMap {
      *            the minimum radius of a hill
      * @param maxRadius
      *            the maximum radius of a hill
-     * @param flattening
-     *            the power of flattening done, 1 means none
      * @param seed
      *            the seed to generate the same heightmap again
      * @throws Exception
@@ -105,8 +103,6 @@ public class HillHeightMap extends AbstractHeightMap {
      *            the minimum radius of a hill
      * @param maxRadius
      *            the maximum radius of a hill
-     * @param flattening
-     *            the power of flattening done, 1 means none
      * @throws Exception
      * @throws JmeException
      *             if size of the terrain is not greater that zero, or number of
@@ -252,7 +248,7 @@ public class HillHeightMap extends AbstractHeightMap {
      * @param minRadius
      *            the minimum radius of a hill
      * @throws Exception
-     * @throw JmeException if the minimum radius is not greater than zero or not
+     * @throws JmeException if the minimum radius is not greater than zero or not
      *        lower than the maximum radius
      */
     public void setMinRadius(float minRadius) throws Exception {

engine/src/test/jme3test/bullet/PhysicsHoverControl.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
@@ -82,7 +82,6 @@ public class PhysicsHoverControl extends PhysicsVehicle implements PhysicsContro
 
     /**
      * Creates a new PhysicsNode with the supplied collision shape
-     * @param child
      * @param shape
      */
     public PhysicsHoverControl(CollisionShape shape) {

engine/src/tools/jme3tools/optimize/TriangleCollector.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
@@ -92,7 +92,7 @@ public class TriangleCollector {
      * (using the indices OCTTriangle.getGeometryIndex() & OCTTriangle.getTriangleIndex())
      * then organizes them into output geometry.
      *
-     * @param geoms
+     * @param inGeoms
      * @param tris
      * @return
      */

engine/src/tools/jme3tools/savegame/SaveGame.java

@@ -83,7 +83,7 @@ public class SaveGame {
      * Loads a savable that has been saved on this system with saveGame() before.
      * @param gamePath A unique path for this game, e.g. com/mycompany/mygame
      * @param dataName A unique name for this savegame, e.g. "save_001"
-     * @param assetManager Link to an AssetManager if required for loading the data (e.g. models with textures)
+     * @param manager Link to an AssetManager if required for loading the data (e.g. models with textures)
      * @return The savable that was saved or null if none was found
      */
     public static Savable loadGame(String gamePath, String dataName, AssetManager manager) {