jme3-core JavaDoc corrections (comments only)

jme3-core/src/main/java/checkers/quals/SubtypeOf.java

@@ -6,8 +6,8 @@ import java.lang.annotation.*;
  * A meta-annotation to specify all the qualifiers that the given qualifier
  * is a subtype of.  This provides a declarative way to specify the type
  * qualifier hierarchy.  (Alternatively, the hierarchy can be defined
- * procedurally by subclassing {@link checkers.types.QualifierHierarchy} or
+ * procedurally by subclassing checkers.types.QualifierHierarchy or
- * {@link checkers.types.TypeHierarchy}.)
+ * checkers.types.TypeHierarchy.)
  *
  * <p>
  * Example:

jme3-core/src/main/java/checkers/quals/package-info.java

@@ -5,6 +5,6 @@
  * They may serve as documentation for the type qualifiers, and aid the
  * Checker Framework to infer the relations between the type qualifiers.
  *
- * @checker.framework.manual #writing-a-checker Writing a checker
+ * checker.framework.manual #writing-a-checker Writing a checker
  */
 package checkers.quals;

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

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -191,7 +191,7 @@ public class Animation implements Savable, Cloneable, JmeCloneable {
     /**
      * 
      * @param spat
-     * @return 
+     * @return a new instance
      */
     public Animation cloneForSpatial(Spatial spat) {
         try {

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

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -45,7 +45,7 @@ public class AnimationUtils {
      * @param time
      * @param duration
      * @param loopMode
-     * @return 
+     * @return the clamped time (in seconds)
      */
      public static float clampWrapTime(float time, float duration, LoopMode loopMode){
          if (time == 0 || duration == 0) {

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

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -160,7 +160,7 @@ public class AudioTrack implements ClonableTrack {
     /**
      * Clone this track
      *
-     * @return
+     * @return a new track
      */
     @Override
     public Track clone() {

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

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -949,7 +949,7 @@ public final class Bone implements Savable, JmeCloneable {
     /**
      * returns true if this bone can be directly manipulated by the user.
      * @see #setUserControl(boolean)
-     * @return
+     * @return true if can be manipulated
      */
     public boolean hasUserControl(){
         return userControl;

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

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -108,7 +108,7 @@ public final class BoneTrack implements JmeCloneable, Track {
 
     /**
      * return the array of rotations of this track
-     * @return 
+     * @return an array
      */
     public Quaternion[] getRotations() {
         return rotations.toObjectArray();
@@ -116,7 +116,7 @@ public final class BoneTrack implements JmeCloneable, Track {
 
     /**
      * returns the array of scales for this track
-     * @return 
+     * @return an array or null
      */
     public Vector3f[] getScales() {
         return scales == null ? null : scales.toObjectArray();
@@ -124,7 +124,7 @@ public final class BoneTrack implements JmeCloneable, Track {
 
     /**
      * returns the arrays of time for this track
-     * @return 
+     * @return the pre-existing array
      */
     public float[] getTimes() {
         return times;
@@ -132,7 +132,7 @@ public final class BoneTrack implements JmeCloneable, Track {
 
     /**
      * returns the array of translations of this track
-     * @return 
+     * @return an array
      */
     public Vector3f[] getTranslations() {
         return translations.toObjectArray();

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

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -127,7 +127,7 @@ public abstract class CompactArray<T> implements JmeCloneable {
      * returns the object for the given index
      * @param index the index
      * @param store an object to store the result 
-     * @return 
+     * @return an element
      */
     public final T get(int index, T store) {
         serialize();
@@ -137,7 +137,7 @@ public abstract class CompactArray<T> implements JmeCloneable {
 
     /**
      * return a float array of serialized data
-     * @return 
+     * @return the pre-existing array
      */
     public final float[] getSerializedData() {
         serialize();
@@ -173,7 +173,7 @@ public abstract class CompactArray<T> implements JmeCloneable {
      * Ensure the capacity for the given array and the given size
      * @param arr the array
      * @param size the size
-     * @return 
+     * @return an array
      */
     protected float[] ensureCapacity(float[] arr, int size) {
         if (arr == null) {
@@ -191,7 +191,7 @@ public abstract class CompactArray<T> implements JmeCloneable {
     /**
      * Return an array of indices for the given objects
      * @param objArray
-     * @return 
+     * @return a new array
      */
     @SuppressWarnings("unchecked")
     public final int[] getIndex(T... objArray) {

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

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -260,7 +260,7 @@ public class EffectTrack implements ClonableTrack {
     /**
      * Clone this track
      *
-     * @return
+     * @return a new instance
      */
     @Override
     public Track clone() {

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

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -199,7 +199,7 @@ public final class Skeleton implements Savable, JmeCloneable {
 
     /**
      * returns the array of all root bones of this skeleton
-     * @return 
+     * @return the pre-existing array
      */
     public Bone[] getRoots() {
         return rootBones;
@@ -208,7 +208,7 @@ public final class Skeleton implements Savable, JmeCloneable {
     /**
      * return a bone for the given index
      * @param index
-     * @return 
+     * @return the pre-existing instance
      */
     public Bone getBone(int index) {
         return boneList[index];
@@ -217,7 +217,7 @@ public final class Skeleton implements Savable, JmeCloneable {
     /**
      * returns the bone with the given name
      * @param name
-     * @return 
+     * @return the pre-existing instance, or null if not found
      */
     public Bone getBone(String name) {
         for (int i = 0; i < boneList.length; i++) {
@@ -231,7 +231,7 @@ public final class Skeleton implements Savable, JmeCloneable {
     /**
      * returns the bone index of the given bone
      * @param bone
-     * @return 
+     * @return the index (&ge;0) or -1 if not found
      */
     public int getBoneIndex(Bone bone) {
         for (int i = 0; i < boneList.length; i++) {
@@ -246,7 +246,7 @@ public final class Skeleton implements Savable, JmeCloneable {
     /**
      * returns the bone index of the bone that has the given name
      * @param name
-     * @return 
+     * @return the index (&ge;0) or -1 if not found 
      */
     public int getBoneIndex(String name) {
         for (int i = 0; i < boneList.length; i++) {
@@ -259,8 +259,8 @@ public final class Skeleton implements Savable, JmeCloneable {
     }
 
     /**
-     * Compute the skining matrices for each bone of the skeleton that would be used to transform vertices of associated meshes
+     * Compute the skinning matrices for each bone of the skeleton that would be used to transform vertices of associated meshes
-     * @return 
+     * @return the pre-existing matrices
      */
     public Matrix4f[] computeSkinningMatrices() {
         TempVars vars = TempVars.get();
@@ -273,7 +273,7 @@ public final class Skeleton implements Savable, JmeCloneable {
 
     /**
      * returns the number of bones of this skeleton
-     * @return 
+     * @return the count (&ge;0)
      */
     public int getBoneCount() {
         return boneList.length;

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

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -445,7 +445,7 @@ public class SkeletonControl extends AbstractControl implements Cloneable, JmeCl
     /**
      * returns the skeleton of this control
      *
-     * @return
+     * @return the pre-existing instance
      */
     public Skeleton getSkeleton() {
         return skeleton;

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

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -348,7 +348,7 @@ public class ChaseCameraAppState extends AbstractAppState implements ActionListe
     /**
      * returns the zoom speed
      *
-     * @return
+     * @return the speed
      */
     public float getZoomSpeed() {
         return zoomSpeed;
@@ -358,7 +358,7 @@ public class ChaseCameraAppState extends AbstractAppState implements ActionListe
      * Sets the zoom speed, the lower the value, the slower the camera will zoom
      * in and out. default is 2.
      *
-     * @param zoomSpeed
+     * @param zoomSpeed the speed
      */
     public void setZoomSpeed(float zoomSpeed) {
         this.zoomSpeed = zoomSpeed;
@@ -415,7 +415,7 @@ public class ChaseCameraAppState extends AbstractAppState implements ActionListe
     /**
      * @return If drag to rotate feature is enabled.
      *
-     * @see FlyByCamera#setDragToRotate(boolean)
+     * @see #setDragToRotate(boolean)
      */
     public boolean isDragToRotate() {
         return dragToRotate;

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

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -485,16 +485,15 @@ public class LegacyApplication implements Application, SystemListener {
     /**
      * Initializes the application's canvas for use.
      * <p>
-     * After calling this method, cast the {@link #getContext() context} to
+     * After calling this method, cast the {@link #getContext()} context to
-     * {@link JmeCanvasContext},
+     * JmeCanvasContext,
-     * then acquire the canvas with {@link JmeCanvasContext#getCanvas() }
+     * then acquire the canvas with JmeCanvasContext.getCanvas()
      * and attach it to an AWT/Swing Frame.
      * The rendering thread will start when the canvas becomes visible on
      * screen, however if you wish to start the context immediately you
      * may call {@link #startCanvas() } to force the rendering thread
      * to start.
      *
-     * @see JmeCanvasContext
      * @see Type#Canvas
      */
     public void createCanvas(){

jme3-core/src/main/java/com/jme3/app/package.html

@@ -50,7 +50,6 @@ public class ExampleUse extends Application {<br>
         app.start();<br>
     }<br>
 <br>
-    @Override<br>
     public void initialize(){<br>
         super.initialize();<br>
 <br>
@@ -58,7 +57,6 @@ public class ExampleUse extends Application {<br>
         viewPort.attachScene(rootNode);<br>
     }<br>
 <br>
-    @Override<br>
     public void update(){<br>
         super.update();<br>
 <br>

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

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012, 2016, 2018 jMonkeyEngine
+ * Copyright (c) 2009-2012, 2016, 2018-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -490,7 +490,7 @@ public class AudioNode extends Node implements AudioSource {
     /**
      * Set to true to enable reverberation effects for this audio node.
      * Does nothing if the audio node is not positional.
-     * <br/>
+     * <br>
      * When enabled, the audio environment set with
      * {@link AudioRenderer#setEnvironment(com.jme3.audio.Environment) }
      * will apply a reverb effect to the audio playing from this audio node.

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

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -47,7 +47,7 @@ public interface AudioRenderer {
     /**
      * Sets the environment, used for reverb effects.
      *
-     * @see AudioSource#setReverbEnabled(boolean)
+     * @see AudioNode#setReverbEnabled(boolean)
      * @param env The environment to set.
      */
     public void setEnvironment(Environment env);

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

@@ -17,7 +17,7 @@ public interface AudioSource {
     public enum Status {
         /**
          * The audio source is currently playing. This will be set if
-         * {@link AudioSource#play() } is called.
+         * {@link AudioNode#play()} is called.
          */
         Playing,
         
@@ -28,7 +28,7 @@ public interface AudioSource {
         
         /**
          * The audio source is currently stopped.
-         * This will be set if {@link AudioSource#stop() } is called 
+         * This will be set if {@link AudioNode#stop()} is called 
          * or the audio has reached the end of the file.
          */
         Stopped,
@@ -47,13 +47,13 @@ public interface AudioSource {
 
     /**
      * @return The {#link Filter dry filter} that is set.
-     * @see AudioSource#setDryFilter(com.jme3.audio.Filter) 
+     * @see AudioNode#setDryFilter(com.jme3.audio.Filter) 
      */
     public Filter getDryFilter();
 
     /**
      * @return The {@link AudioData} set previously with 
-     * {@link AudioSource#setAudioData(com.jme3.audio.AudioData, com.jme3.audio.AudioKey) }
+     * {@link AudioNode#setAudioData(com.jme3.audio.AudioData, com.jme3.audio.AudioKey)}
      * or any of the constructors that initialize the audio data.
      */
     public AudioData getAudioData();
@@ -65,34 +65,34 @@ public interface AudioSource {
     
     /**
      * @return The {@link Status} of the audio source. 
-     * The status will be changed when either the {@link AudioSource#play() }
+     * The status will be changed when either the {@link AudioNode#play()}
-     * or {@link AudioSource#stop() } methods are called.
+     * or {@link AudioNode#stop()} methods are called.
      */
     public Status getStatus();
 
     /**
      * @return True if the audio will keep looping after it is done playing,
      * otherwise, false.
-     * @see AudioSource#setLooping(boolean)
+     * @see AudioNode#setLooping(boolean)
      */
     public boolean isLooping();
 
     /**
      * @return The pitch of the audio, also the speed of playback.
      * 
-     * @see AudioSource#setPitch(float) 
+     * @see AudioNode#setPitch(float) 
      */
     public float getPitch();
 
     /**
      * @return The volume of this audio source.
      * 
-     * @see AudioSource#setVolume(float)
+     * @see AudioNode#setVolume(float)
      */
     public float getVolume();
 
     /**
-     * @return the time offset in the sound sample when to start playing.
+     * @return the time offset in the sound sample to start playing
      */
     public float getTimeOffset();
     
@@ -102,79 +102,77 @@ public interface AudioSource {
     public float getPlaybackTime();
 
     /**
-     * @return The velocity of the audio source.
+     * @return The position of the audio source.
-     * 
-     * @see AudioSource#setVelocity(com.jme3.math.Vector3f)
      */
     public Vector3f getPosition();
     
     /**
      * @return The velocity of the audio source.
      * 
-     * @see AudioSource#setVelocity(com.jme3.math.Vector3f)
+     * @see AudioNode#setVelocity(com.jme3.math.Vector3f)
      */
     public Vector3f getVelocity();
 
     /**
      * @return True if reverb is enabled, otherwise false.
      * 
-     * @see AudioSource#setReverbEnabled(boolean)
+     * @see AudioNode#setReverbEnabled(boolean)
      */
     public boolean isReverbEnabled();
 
     /**
      * @return Filter for the reverberations of this audio source.
      * 
-     * @see AudioSource#setReverbFilter(com.jme3.audio.Filter) 
+     * @see AudioNode#setReverbFilter(com.jme3.audio.Filter) 
      */
     public Filter getReverbFilter();
 
     /**
      * @return Max distance for this audio source.
      * 
-     * @see AudioSource#setMaxDistance(float)
+     * @see AudioNode#setMaxDistance(float)
      */
     public float getMaxDistance();
 
     /**
      * @return The reference playing distance for the audio source.
      * 
-     * @see AudioSource#setRefDistance(float) 
+     * @see AudioNode#setRefDistance(float) 
      */
     public float getRefDistance();
 
     /**
      * @return True if the audio source is directional
      * 
-     * @see AudioSource#setDirectional(boolean) 
+     * @see AudioNode#setDirectional(boolean) 
      */
     public boolean isDirectional();
 
     /**
      * @return The direction of this audio source.
      * 
-     * @see AudioSource#setDirection(com.jme3.math.Vector3f)
+     * @see AudioNode#setDirection(com.jme3.math.Vector3f)
      */
     public Vector3f getDirection();
 
     /**
      * @return The directional audio source, cone inner angle.
      * 
-     * @see AudioSource#setInnerAngle(float) 
+     * @see AudioNode#setInnerAngle(float) 
      */
     public float getInnerAngle();
 
     /**
      * @return The directional audio source, cone outer angle.
      * 
-     * @see AudioSource#setOuterAngle(float) 
+     * @see AudioNode#setOuterAngle(float) 
      */
     public float getOuterAngle();
 
     /**
      * @return True if the audio source is positional.
      * 
-     * @see AudioSource#setPositional(boolean) 
+     * @see AudioNode#setPositional(boolean) 
      */
     public boolean isPositional();
 

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

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -897,7 +897,7 @@ public class ALAudioRenderer implements AudioRenderer, Runnable {
                             reclaimChannel = true;
                         } else {
                             // Stream still has data. 
-                            // Buffer starvation occured.
+                            // Buffer starvation occurred.
                             // Audio decoder thread will fill the data 
                             // and start the channel again.
                         }

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

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -285,7 +285,7 @@ public class Cinematic extends AbstractCinematicEvent implements AppState {
     /**
      * used internally
      *
-     * @return
+     * @return true if initialized, otherwise false
      */
     public boolean isInitialized() {
         return initialized;
@@ -636,7 +636,7 @@ public class Cinematic extends AbstractCinematicEvent implements AppState {
      *
      * @param type the type of data
      * @param key the key
-     * @return
+     * @return the pre-existing object, or null
      */
     public Object getEventData(String type, Object key) {
         if (eventsData != null) {

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

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -244,7 +244,7 @@ public class MotionPath implements Savable {
 
     /**
      * returns an iterator on the waypoints collection
-     * @return
+     * @return an iterator
      */
     public Iterator<Vector3f> iterator() {
         return spline.getControlPoints().iterator();
@@ -317,7 +317,7 @@ public class MotionPath implements Savable {
 
     /**
      * return the number of waypoints of this path
-     * @return
+     * @return the count (&ge;0)
      */
     public int getNbWayPoints() {
         return spline.getControlPoints().size();
@@ -334,7 +334,7 @@ public class MotionPath implements Savable {
 
     /**
      * Returns the curve tension
-     * @return
+     * @return the curve tension
      */
     public float getCurveTension() {
         return spline.getCurveTension();
@@ -378,7 +378,7 @@ public class MotionPath implements Savable {
 
     /**
      * returns true if the path is a cycle
-     * @return
+     * @return true if the path is a cycle
      */
     public boolean isCycle() {
         return spline.isCycle();

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

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -200,7 +200,7 @@ public abstract class AbstractCinematicEvent implements CinematicEvent {
 
     /**
      * Returns the actual duration of the animation (initialDuration/speed)
-     * @return
+     * @return the duration (in seconds)
      */
     public float getDuration() {
         return initialDuration / speed;
@@ -218,7 +218,7 @@ public abstract class AbstractCinematicEvent implements CinematicEvent {
 
     /**
      * Returns the speed of the animation.
-     * @return
+     * @return the speed
      */
     public float getSpeed() {
         return speed;
@@ -226,7 +226,7 @@ public abstract class AbstractCinematicEvent implements CinematicEvent {
 
     /**
      * Returns the current playstate of the animation (playing or paused or stopped).
-     * @return
+     * @return the enum value
      */
     public PlayState getPlayState() {
         return playState;
@@ -234,7 +234,7 @@ public abstract class AbstractCinematicEvent implements CinematicEvent {
 
     /**
      * Returns the initial duration of the animation at speed = 1 in seconds.
-     * @return
+     * @return the duration in seconds
      */
     public float getInitialDuration() {
         return initialDuration;
@@ -251,7 +251,7 @@ public abstract class AbstractCinematicEvent implements CinematicEvent {
     /**
      * Returns the loopMode of the animation.
      * @see LoopMode
-     * @return
+     * @return the enum value
      */
     public LoopMode getLoopMode() {
         return loopMode;

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

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2016 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -231,7 +231,7 @@ public class MotionEvent extends AbstractCinematicEvent implements Control, JmeC
 
     /**
      * This method is meant to be called by the motion path only.
-     * @return
+     * @return true if needed, otherwise false
      */
     public boolean needsDirection() {
         return directionType == Direction.Path || directionType == Direction.PathAndRotation;
@@ -272,7 +272,7 @@ public class MotionEvent extends AbstractCinematicEvent implements Control, JmeC
     /**
      * Clone this control for the given spatial.
      * @param spatial
-     * @return
+     * @return never
      */
     @Override
     public Control cloneForSpatial(Spatial spatial) {
@@ -334,7 +334,7 @@ public class MotionEvent extends AbstractCinematicEvent implements Control, JmeC
 
     /**
      * This method is meant to be called by the motion path only.
-     * @return
+     * @return the value
      */
     public float getCurrentValue() {
         return currentValue;
@@ -350,7 +350,7 @@ public class MotionEvent extends AbstractCinematicEvent implements Control, JmeC
 
     /**
      * This method is meant to be called by the motion path only.
-     * @return
+     * @return the waypoint index
      */
     public int getCurrentWayPoint() {
         return currentWayPoint;
@@ -366,7 +366,7 @@ public class MotionEvent extends AbstractCinematicEvent implements Control, JmeC
 
     /**
      * Returns the direction the spatial is moving.
-     * @return
+     * @return the pre-existing vector
      */
     public Vector3f getDirection() {
         return direction;
@@ -444,7 +444,7 @@ public class MotionEvent extends AbstractCinematicEvent implements Control, JmeC
 
     /**
      * Return the motion path this control follows.
-     * @return
+     * @return the pre-existing instance
      */
     public MotionPath getPath() {
         return path;
@@ -483,7 +483,7 @@ public class MotionEvent extends AbstractCinematicEvent implements Control, JmeC
 
     /**
      * Return the distance traveled by the spatial on the path.
-     * @return 
+     * @return the distance
      */
     public float getTraveledDistance() {
         return traveledDistance;

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

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -194,7 +194,7 @@ public class SoundEvent extends AbstractCinematicEvent {
 
     /**
      *  Returns the underlying audio node of this sound track
-     * @return
+     * @return the pre-existing instance
      */
     public AudioNode getAudioNode() {
         return audioNode;

jme3-core/src/main/java/com/jme3/collision/CollisionResult.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -39,7 +39,7 @@ import com.jme3.scene.Mesh;
 /**
  * A <code>CollisionResult</code> represents a single collision instance
  * between two {@link Collidable}. A collision check can result in many
- * collision instances (places where collision has occured).
+ * collision instances (places where collision has occurred).
  *
  * @author Kirill Vainer
  */

jme3-core/src/main/java/com/jme3/collision/CollisionResults.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -130,7 +130,7 @@ public class CollisionResults implements Iterable<CollisionResult> {
     /**
      * Internal use only.
      * @param index
-     * @return
+     * @return the pre-existing instance
      */
     public CollisionResult getCollisionDirect(int index){
         if (results == null) {

jme3-core/src/main/java/com/jme3/effect/ParticleEmitter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -854,7 +854,7 @@ public class ParticleEmitter extends Geometry {
      * Use ParticleEmitter.getParticleInfluencer().setInitialVelocity(initialVelocity); instead.
      *
      * @see ParticleEmitter#setVelocityVariation(float)
-     * @see ParticleEmitter#setGravity(float)
+     * @see #setGravity(com.jme3.math.Vector3f) 
      */
     @Deprecated
     public void setInitialVelocity(Vector3f initialVelocity) {
@@ -876,7 +876,8 @@ public class ParticleEmitter extends Geometry {
      * @param variation Set the variation by which the initial velocity
      * of the particle is determined. <code>variation</code> should be a value
      * from 0 to 1, where 0 means particles are to spawn with exactly
-     * the velocity given in {@link ParticleEmitter#setStartVel(com.jme3.math.Vector3f) },
+     * the velocity specified in 
+     * {@link com.jme3.effect.influencers.ParticleInfluencer#setInitialVelocity(com.jme3.math.Vector3f)},
      * and 1 means particles are to spawn with a completely random velocity.
      *
      * @deprecated

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

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -106,7 +106,7 @@ public class RadialParticleInfluencer extends DefaultParticleInfluencer {
 
     /**
      * nullify y component of particle velocity to make the effect expand only on x and z axis
-     * @return
+     * @return true if nullifying, otherwise false
      */
     public boolean isHorizontal() {
         return horizontal;

jme3-core/src/main/java/com/jme3/environment/EnvironmentCamera.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2015 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -294,7 +294,7 @@ public class EnvironmentCamera extends BaseAppState {
     /**
      * returns the images format used for the generated maps.
      *
-     * @return
+     * @return the enum value
      */
     public Image.Format getImageFormat() {
         return imageFormat;
@@ -316,7 +316,7 @@ public class EnvironmentCamera extends BaseAppState {
      * @param axisX the x axis
      * @param axisY the y axis
      * @param axisZ tha z axis
-     * @return
+     * @return a new instance
      */
     protected Camera createOffCamera(final int mapSize, final Vector3f worldPos, final Vector3f axisX, final Vector3f axisY, final Vector3f axisZ) {
         final Camera offCamera = new Camera(mapSize, mapSize);
@@ -332,7 +332,7 @@ public class EnvironmentCamera extends BaseAppState {
      *
      * @param name
      * @param offCamera
-     * @return
+     * @return a new instance
      */
     protected ViewPort createOffViewPort(final String name, final Camera offCamera) {
         final ViewPort offView = new ViewPort(name, offCamera);
@@ -346,7 +346,7 @@ public class EnvironmentCamera extends BaseAppState {
      *
      * @param mapSize
      * @param offView
-     * @return
+     * @return a new instance
      */
     protected FrameBuffer createOffScreenFrameBuffer(int mapSize, ViewPort offView) {
         // create offscreen framebuffer

jme3-core/src/main/java/com/jme3/environment/LightProbeFactory.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -50,10 +50,11 @@ import java.util.concurrent.ScheduledThreadPoolExecutor;
  * The process is as follows: 
  * 1. Create an EnvironmentCamera
  * 2. give it a position in the scene
- * 3. call {@link LightProbeFactory#makeProbe(com.jme3.environment.EnvironmentCamera, com.jme3.scene.Node)}
+ * 3. call {@link LightProbeFactory#makeProbe(com.jme3.environment.EnvironmentCamera, com.jme3.scene.Spatial)}
  * 4. add the created LightProbe to a node with the {@link Node#addLight(com.jme3.light.Light) } method.
  * 
- * Optionally for step 3 call {@link LightProbeFactory#makeProbe(com.jme3.environment.EnvironmentCamera, com.jme3.scene.Node, com.jme3.environment.generation.JobProgressListener) }
+ * Optionally for step 3 call
+ * {@link #makeProbe(com.jme3.environment.EnvironmentCamera, com.jme3.scene.Spatial, com.jme3.environment.generation.JobProgressListener)}
  * with a {@link JobProgressListener} to be notified of the progress of the generation process.
  * 
  * The generation will be split in several threads for faster generation. 
@@ -77,7 +78,8 @@ public class LightProbeFactory {
      * The process is thread safe.
      * The created lightProbe will only be marked as ready when the rendering process is done.
      * 
-     * If you want to monitor the process use {@link LightProbeFactory#makeProbe(com.jme3.environment.EnvironmentCamera, com.jme3.scene.Node, com.jme3.environment.generation.JobProgressListener) }
+     * If you want to monitor the process use
+     * {@link #makeProbe(com.jme3.environment.EnvironmentCamera, com.jme3.scene.Spatial, com.jme3.environment.generation.JobProgressListener)}
      * 
      *
      * 

jme3-core/src/main/java/com/jme3/environment/generation/IrradianceSphericalHarmonicsGenerator.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -70,7 +70,7 @@ public class IrradianceSphericalHarmonicsGenerator extends RunnableWithProgress
      * Fills all the generation parameters
      *
      * @param sourceMap the source cube map
-     *                  {@link EnvMapUtils.FixSeamsMethod}
+     *                  {@link com.jme3.environment.util.EnvMapUtils.FixSeamsMethod}
      * @param store     The cube map to store the result in.
      */
     public void setGenerationParam(TextureCubeMap sourceMap, LightProbe store) {

jme3-core/src/main/java/com/jme3/environment/generation/PrefilteredEnvMapFaceGenerator.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -96,8 +96,9 @@ public class PrefilteredEnvMapFaceGenerator extends RunnableWithProgress {
      * @param sourceMap      the source cube map
      * @param targetMapSize  the size of the generated map (width or height in
      *                       pixel)
-     * @param fixSeamsMethod the method used to fix seams as described here
+     * @param fixSeamsMethod the method used to fix seams as described in
-     *                       {@link EnvMapUtils.FixSeamsMethod}
+     *                       {@link com.jme3.environment.util.EnvMapUtils.FixSeamsMethod}
+     * @param genType
      * @param store          The cube map to store the result in.
      */
     public void setGenerationParam(TextureCubeMap sourceMap, int targetMapSize, EnvMapUtils.FixSeamsMethod fixSeamsMethod, EnvMapUtils.GenerationType genType, TextureCubeMap store) {
@@ -331,8 +332,8 @@ public class PrefilteredEnvMapFaceGenerator extends RunnableWithProgress {
      *
      * @param xi
      * @param a2
-     * @param store
+     * @param store caller-provided storage
-     * @return
+     * @return either store or a new vector (not null)
      */
     public Vector3f importanceSampleGGX(Vector4f xi, float a2, Vector3f store) {
         if (store == null) {

jme3-core/src/main/java/com/jme3/environment/generation/RunnableWithProgress.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -63,7 +63,7 @@ public abstract class RunnableWithProgress implements Runnable {
     /**
      * return the current progress of the process.
      *
-     * @return
+     * @return fraction (≥0, ≤1)
      */
     public double getProgress() {
         return (double) progress / (double) end;

jme3-core/src/main/java/com/jme3/environment/util/EnvMapUtils.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2015 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -136,13 +136,13 @@ public class EnvMapUtils {
      * original ones. see {@link ByteBuffer#duplicate()}
      *
      * Use this if you need to read from the map from multiple threads, it
-     * should garanty the thread safety. Note that if you want to write to the
+     * should guaranty the thread safety. Note that if you want to write to the
      * cube map you have to make sure that the different thread do not write to
      * the same area of the buffer. The position, limit and mark are not an
      * issue.
      *
      * @param sourceMap
-     * @return
+     * @return a new instance
      */
     public static TextureCubeMap duplicateCubeMap(TextureCubeMap sourceMap) {
         Image srcImg = sourceMap.getImage();
@@ -233,7 +233,7 @@ public class EnvMapUtils {
      * @param face the face to consider
      * @param store a vector3f where the resulting vector will be stored
      * @param fixSeamsMethod the method to fix the seams
-     * @return
+     * @return either store or a new vector
      */
     public static Vector3f getVectorFromCubemapFaceTexCoord(int x, int y, int mapSize, int face, Vector3f store, FixSeamsMethod fixSeamsMethod) {
         if (store == null) {
@@ -396,12 +396,12 @@ public class EnvMapUtils {
 
     /**
      * same as
-     * {@link EnvMapUtils#getSphericalHarmonicsCoefficents(com.jme3.texture.TextureCubeMap, com.jme3.utils.EnvMapUtils.FixSeamsMethod)}
+     * {@link #getSphericalHarmonicsCoefficents(com.jme3.texture.TextureCubeMap, com.jme3.environment.util.EnvMapUtils.FixSeamsMethod)}
      * the fix method used is {@link FixSeamsMethod#Wrap}
      *
      * @param cubeMap the environment cube map to compute SH for
-     * @return an array of 9 vector3f representing thos coefficients for each
+     * @return an array of 9 vectors representing the coefficients for each
-     * r,g,b channnel
+     * RGB channel
      */
     public static Vector3f[] getSphericalHarmonicsCoefficents(TextureCubeMap cubeMap) {
         return getSphericalHarmonicsCoefficents(cubeMap, FixSeamsMethod.Wrap);
@@ -419,8 +419,8 @@ public class EnvMapUtils {
      * @param cubeMap the environment cube map to compute SH for
      * @param fixSeamsMethod method to fix seams when computing the SH
      * coefficients
-     * @return an array of 9 vector3f representing thos coefficients for each
+     * @return an array of 9 vectors representing the coefficients for each
-     * r,g,b channnel
+     * RGB channel
      */
     public static Vector3f[] getSphericalHarmonicsCoefficents(TextureCubeMap cubeMap, FixSeamsMethod fixSeamsMethod) {
 
@@ -604,7 +604,7 @@ public class EnvMapUtils {
      *
      * @param cubeMap the cube map
      * @param assetManager the asset Manager
-     * @return
+     * @return a new Node
      */
     public static Node getCubeMapCrossDebugView(TextureCubeMap cubeMap, AssetManager assetManager) {
         Node n = new Node("CubeMapDebug" + cubeMap.getName());

jme3-core/src/main/java/com/jme3/environment/util/LightsDebugState.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -144,7 +144,7 @@ public class LightsDebugState extends BaseAppState {
 
     /**
      * returns the scale of the probe's debug sphere
-     * @return 
+     * @return the scale factor
      */
     public float getProbeScale() {
         return probeScale;

jme3-core/src/main/java/com/jme3/font/BitmapCharacterSet.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -180,7 +180,7 @@ public class BitmapCharacterSet implements Savable {
      * Merge two fonts.
      * If two font have the same style, merge will fail.
      * @param styleSet Style must be assigned to this.
-     * @author Yonghoon
+     * author: Yonghoon
      */
     public void merge(BitmapCharacterSet styleSet) {
         if (this.renderedSize != styleSet.renderedSize) {

jme3-core/src/main/java/com/jme3/font/BitmapFont.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -261,7 +261,7 @@ public class BitmapFont implements Savable {
      * Merge two fonts.
      * If two font have the same style, merge will fail.
      * @param newFont Style must be assigned to this.
-     * @author Yonghoon
+     * author: Yonghoon
      */
     public void merge(BitmapFont newFont) {
         charSet.merge(newFont.charSet);

jme3-core/src/main/java/com/jme3/input/ChaseCamera.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -269,7 +269,7 @@ public class ChaseCamera implements ActionListener, AnalogListener, Control, Jme
     /**
     * Cleans up the input mappings from the input manager.
     * Undoes the work of registerWithInput().
-    * @param inputManager InputManager from which to cleanup mappings.
+    * @param mgr the InputManager to clean up
     */
     public void cleanupWithInput(InputManager mgr){
         mgr.deleteMapping(CameraInput.CHASECAM_TOGGLEROTATE);
@@ -583,7 +583,7 @@ public class ChaseCamera implements ActionListener, AnalogListener, Control, Jme
     /**
      * clone this camera for a spatial
      * @param spatial
-     * @return
+     * @return never
      */
     @Override
     public Control cloneForSpatial(Spatial spatial) {
@@ -709,7 +709,7 @@ public class ChaseCamera implements ActionListener, AnalogListener, Control, Jme
 
     /**
      * returns the chasing sensitivity
-     * @return
+     * @return the sensitivity
      */
     public float getChasingSensitivity() {
         return chasingSensitivity;
@@ -728,7 +728,7 @@ public class ChaseCamera implements ActionListener, AnalogListener, Control, Jme
 
     /**
      * Returns the rotation sensitivity
-     * @return
+     * @return the sensitivity
      */
     public float getRotationSensitivity() {
         return rotationSensitivity;
@@ -747,7 +747,7 @@ public class ChaseCamera implements ActionListener, AnalogListener, Control, Jme
 
     /**
      * returns true if the trailing is enabled
-     * @return
+     * @return true if enabled, otherwise false
      */
     public boolean isTrailingEnabled() {
         return trailingEnabled;
@@ -765,7 +765,7 @@ public class ChaseCamera implements ActionListener, AnalogListener, Control, Jme
     /**
      *
      * returns the trailing rotation inertia
-     * @return
+     * @return the inertia
      */
     public float getTrailingRotationInertia() {
         return trailingRotationInertia;
@@ -783,7 +783,7 @@ public class ChaseCamera implements ActionListener, AnalogListener, Control, Jme
 
     /**
      * returns the trailing sensitivity
-     * @return
+     * @return the sensitivity
      */
     public float getTrailingSensitivity() {
         return trailingSensitivity;
@@ -801,7 +801,7 @@ public class ChaseCamera implements ActionListener, AnalogListener, Control, Jme
 
     /**
      * returns the zoom sensitivity
-     * @return
+     * @return the sensitivity
      */
     public float getZoomSensitivity() {
         return zoomSensitivity;
@@ -865,7 +865,7 @@ public class ChaseCamera implements ActionListener, AnalogListener, Control, Jme
     /**
      * @return If drag to rotate feature is enabled.
      *
-     * @see FlyByCamera#setDragToRotate(boolean)
+     * @see #setDragToRotate(boolean)
      */
     public boolean isDragToRotate() {
         return dragToRotate;
@@ -906,7 +906,7 @@ public class ChaseCamera implements ActionListener, AnalogListener, Control, Jme
 
     /**
      * return the current distance from the camera to the target
-     * @return
+     * @return the distance
      */
     public float getDistanceToTarget() {
         return distance;
@@ -914,7 +914,7 @@ public class ChaseCamera implements ActionListener, AnalogListener, Control, Jme
 
     /**
      * returns the current horizontal rotation around the target in radians
-     * @return
+     * @return the angle
      */
     public float getHorizontalRotation() {
         return rotation;
@@ -922,7 +922,7 @@ public class ChaseCamera implements ActionListener, AnalogListener, Control, Jme
 
     /**
      * returns the current vertical rotation around the target in radians.
-     * @return
+     * @return the angle in radians
      */
     public float getVerticalRotation() {
         return vRotation;
@@ -930,7 +930,7 @@ public class ChaseCamera implements ActionListener, AnalogListener, Control, Jme
 
     /**
      * returns the offset from the target's position where the camera looks at
-     * @return
+     * @return the pre-existing vector
      */
     public Vector3f getLookAtOffset() {
         return lookAtOffset;
@@ -954,7 +954,7 @@ public class ChaseCamera implements ActionListener, AnalogListener, Control, Jme
 
     /**
      * Returns the up vector of the camera used for the lookAt on the target
-     * @return
+     * @return the pre-existing vector
      */
     public Vector3f getUpVector() {
         return initialUpVec;

jme3-core/src/main/java/com/jme3/input/event/InputEvent.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -47,7 +47,7 @@ public abstract class InputEvent {
      * The time when the event occurred. This is relative to
      * {@link Input#getInputTimeNanos() }.
      * 
-     * @return time when the event occured
+     * @return time when the event occurred
      */
     public long getTime(){
         return time;

jme3-core/src/main/java/com/jme3/input/event/JoyAxisEvent.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -53,7 +53,7 @@ public class JoyAxisEvent extends InputEvent {
     /**
      * Returns the JoystickAxis that triggered this event.
      *
-     * @see JoystickAxis#assignAxis(java.lang.String, java.lang.String, int) 
+     * @see com.jme3.input.JoystickAxis#assignAxis(java.lang.String, java.lang.String)
      */
     public JoystickAxis getAxis() {
         return axis;
@@ -64,7 +64,7 @@ public class JoyAxisEvent extends InputEvent {
      * 
      * @return joystick axis index.
      * 
-     * @see Joystick#assignAxis(java.lang.String, java.lang.String, int) 
+     * @see com.jme3.input.JoystickAxis#assignAxis(java.lang.String, java.lang.String)
      */
     public int getAxisIndex() {
         return axis.getAxisId();

jme3-core/src/main/java/com/jme3/input/event/JoyButtonEvent.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -52,7 +52,8 @@ public class JoyButtonEvent extends InputEvent {
     /**
      * Returns the JoystickButton that triggered this event.
      *
-     * @see JoystickAxis#assignAxis(java.lang.String, java.lang.String, int) 
+     * @see com.jme3.input.JoystickAxis#assignAxis(java.lang.String, java.lang.String)
+     * @return the button
      */
     public JoystickButton getButton() {
         return button;

jme3-core/src/main/java/com/jme3/light/LightProbe.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2015 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -62,7 +62,8 @@ import java.util.logging.Logger;
  * - The irradiance spherical harmonics factors (used for indirect diffuse lighting in the PBR pipeline).
  * - The prefiltered environment map (used for indirect specular lighting and reflection in the PBE pipeline).
  * Note that when instantiating the LightProbe, both of those structures are null.
- * To compute them see {@link LightProbeFactory#makeProbe(com.jme3.environment.EnvironmentCamera, com.jme3.scene.Node)}
+ * To compute them see
+ * {@link com.jme3.environment.LightProbeFactory#makeProbe(com.jme3.environment.EnvironmentCamera, com.jme3.scene.Spatial)}
  * and {@link EnvironmentCamera}.
  * 
  * The light probe has an area of effect that is a bounding volume centered on its position. (for now only Bounding spheres are supported).
@@ -89,7 +90,9 @@ public class LightProbe extends Light implements Savable {
 
     /**
      * Empty constructor used for serialization.
-     * You should never call it, use {@link LightProbeFactory#makeProbe(com.jme3.environment.EnvironmentCamera, com.jme3.scene.Node)} instead
+     * You should never call it, use 
+     * {@link com.jme3.environment.LightProbeFactory#makeProbe(com.jme3.environment.EnvironmentCamera, com.jme3.scene.Spatial)}
+     * instead.
      */
     public LightProbe() {        
     }

jme3-core/src/main/java/com/jme3/material/Material.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -364,7 +364,7 @@ public class Material implements CloneableSmartAsset, Cloneable, Savable {
      * <p>This value is merely a marker, by itself it does nothing.
      * Generally model loaders will use this marker to indicate
      * the material should receive shadows and therefore any
-     * geometries using it should have the {@link ShadowMode#Receive} set
+     * geometries using it should have {@link com.jme3.renderer.queue.RenderQueue.ShadowMode#Receive} set
      * on them.
      *
      * @param receivesShadows if the material should receive shadows or not.
@@ -891,7 +891,7 @@ public class Material implements CloneableSmartAsset, Cloneable, Savable {
      * or the first default technique that the renderer supports
      * (based on the technique's {@link TechniqueDef#getRequiredCaps() requested rendering capabilities})<ul>
      * <li>If the technique has been changed since the last frame, then it is notified via
-     * {@link Technique#makeCurrent(com.jme3.asset.AssetManager, boolean, java.util.EnumSet)
+     * {@link Technique#makeCurrent(com.jme3.renderer.RenderManager, com.jme3.util.SafeArrayList, com.jme3.util.SafeArrayList, com.jme3.light.LightList, java.util.EnumSet)
      * Technique.makeCurrent()}.
      * If the technique wants to use a shader to render the model, it should load it at this part -
      * the shader should have all the proper defines as declared in the technique definition,
@@ -907,7 +907,7 @@ public class Material implements CloneableSmartAsset, Cloneable, Savable {
      * <li>{@link RenderManager#getForcedRenderState() RenderManager's Forced RenderState}
      * - i.e. renderstate requested by a {@link com.jme3.post.SceneProcessor} or
      * post-processing filter.</li></ol>
-     * <li>If the technique {@link TechniqueDef#isUsingShaders() uses a shader}, then the uniforms of the shader must be updated.<ul>
+     * <li>If the technique uses a shader, then the uniforms of the shader must be updated.<ul>
      * <li>Uniforms bound to material parameters are updated based on the current material parameter values.</li>
      * <li>Uniforms bound to world parameters are updated from the RenderManager.
      * Internally {@link UniformBindingManager} is used for this task.</li>
@@ -922,8 +922,8 @@ public class Material implements CloneableSmartAsset, Cloneable, Savable {
      * rendered with {@link BlendMode#AlphaAdditive alpha-additive} blending and depth writing disabled.</li>
      * </ul>
      * <li>For techniques that do not use shaders,
-     * fixed function OpenGL is used to render the model (see {@link GL1Renderer} interface):<ul>
+     * fixed function OpenGL is used to render the model (see {@link com.jme3.renderer.opengl.GLRenderer} interface):<ul>
-     * <li>OpenGL state ({@link FixedFuncBinding}) that is bound to material parameters is updated. </li>
+     * <li>OpenGL state that is bound to material parameters is updated. </li>
      * <li>The texture set on the material is uploaded and bound.
      * Currently only 1 texture is supported for fixed function techniques.</li>
      * <li>If the technique uses lighting, then OpenGL lighting state is updated

jme3-core/src/main/java/com/jme3/material/MaterialDef.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -128,9 +128,7 @@ public class MaterialDef{
      * 
      * @param type Type of the parameter
      * @param name Name of the parameter
-     * @param value Default value of the parameter
+     * @param colorSpace the color space of the texture required by this texture param
-     * @param ffBinding Fixed function binding for the parameter
-     * @param colorSpace the color space of the texture required by thiis texture param
      * @see ColorSpace
      */
     public void addMaterialParamTexture(VarType type, String name, ColorSpace colorSpace) {

jme3-core/src/main/java/com/jme3/material/RenderState.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -983,7 +983,8 @@ public class RenderState implements Cloneable, Savable {
 
     /**
      * Sets the mesh line width.
-     * This is to use in conjunction with {@link #setWireframe(boolean)} or with a mesh in {@link Mesh.Mode#Lines} mode.
+     * Use this in conjunction with {@link #setWireframe(boolean)} or with a mesh in
+     * {@link com.jme3.scene.Mesh.Mode#Lines} mode.
      * @param lineWidth the line width.
      */
     public void setLineWidth(float lineWidth) {

jme3-core/src/main/java/com/jme3/material/Technique.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -183,7 +183,7 @@ public final class Technique {
      *
      * @deprecated Preset defines are precompiled into
      * {@link TechniqueDef#getShaderPrologue()}, whereas dynamic defines are
-     * available via {@link #getParamDefines()}.
+     * available via {@link #getDynamicDefines()}.
      */
     @Deprecated
     public DefineList getAllDefines() {

jme3-core/src/main/java/com/jme3/material/TechniqueDef.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -290,7 +290,7 @@ public class TechniqueDef implements Savable, Cloneable {
      *
      * @param noRender not render or render ?
      *
-     * @see NoRender
+     * @see #isNoRender()
      */
     public void setNoRender(boolean noRender) {
         this.noRender = noRender;
@@ -374,7 +374,7 @@ public class TechniqueDef implements Savable, Cloneable {
      * @param paramName The parameter name to look up
      * @return The define name
      *
-     * @see #addShaderParamDefine(java.lang.String, java.lang.String)
+     * @see #addShaderParamDefine(java.lang.String, com.jme3.shader.VarType, java.lang.String)
      */
     public String getShaderParamDefine(String paramName){
         Integer defineId = paramToDefineId.get(paramName);
@@ -610,7 +610,7 @@ public class TechniqueDef implements Savable, Cloneable {
     /**
      * returns the weight of the technique def
      *
-     * @return
+     * @return the weight
      */
     public float getWeight() {
         return weight;
@@ -723,7 +723,7 @@ public class TechniqueDef implements Savable, Cloneable {
 
     /**
      * Returns the Enum containing the ShaderProgramNames;
-     * @return
+     * @return the pre-existing EnumMap
      */
     public EnumMap<Shader.ShaderType, String> getShaderProgramNames() {
         return shaderNames;
@@ -731,7 +731,7 @@ public class TechniqueDef implements Savable, Cloneable {
 
     /**
      * Returns the Enum containing the ShaderProgramLanguages;
-     * @return
+     * @return the pre-existing EnumMap
      */
     public EnumMap<Shader.ShaderType, String> getShaderProgramLanguages() {
         return shaderLanguages;

jme3-core/src/main/java/com/jme3/material/logic/TechniqueDefLogic.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2015 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -48,9 +48,9 @@ import java.util.EnumSet;
  * <code>TechniqueDefLogic</code> is used to customize how 
  * a material should be rendered.
  * 
- * Typically used to implement {@link LightMode lighting modes}.
+ * Typically used to implement {@link com.jme3.material.TechniqueDef.LightMode lighting modes}.
  * Implementations can register 
- * {@link TechniqueDef#addShaderUnmappedDefine(java.lang.String) unmapped defines} 
+ * {@link com.jme3.material.TechniqueDef#addShaderUnmappedDefine(java.lang.String, com.jme3.shader.VarType) unmapped defines} 
  * in their constructor and then later set them based on the geometry 
  * or light environment being rendered.
  * 
@@ -69,7 +69,7 @@ public interface TechniqueDefLogic {
      * @param lights The lights with which the geometry shall be rendered. This
      * list must not include culled lights.
      * @param defines The define list used by the technique, any 
-     * {@link TechniqueDef#addShaderUnmappedDefine(java.lang.String) unmapped defines}
+     * {@link com.jme3.material.TechniqueDef#addShaderUnmappedDefine(java.lang.String, com.jme3.shader.VarType) unmapped defines}
      * should be set here to change shader behavior.
      * 
      * @return The shader to use for rendering.
@@ -80,16 +80,16 @@ public interface TechniqueDefLogic {
     /**
      * Requests that the <code>TechniqueDefLogic</code> renders the given geometry.
      * 
-     * Fixed material functionality such as {@link RenderState}, 
+     * Fixed material functionality such as {@link com.jme3.material.RenderState}, 
-     * {@link MatParam material parameters}, and 
+     * {@link com.jme3.material.MatParam material parameters}, and 
-     * {@link UniformBinding uniform bindings}
+     * {@link com.jme3.shader.UniformBinding uniform bindings}
      * have already been applied by the material, however, 
-     * {@link RenderState}, {@link Uniform uniforms}, {@link Texture textures},
+     * {@link com.jme3.material.RenderState}, {@link Uniform uniforms}, {@link Texture textures},
-     * can still be overriden.
+     * can still be overridden.
      * 
      * @param renderManager The render manager to perform the rendering against.
-     * * @param shader The shader that was selected by this logic in 
+     * @param shader The shader that was selected by this logic in 
-     * {@link #makeCurrent(com.jme3.asset.AssetManager, com.jme3.renderer.RenderManager, java.util.EnumSet, com.jme3.shader.DefineList)}.
+     * {@link #makeCurrent(com.jme3.asset.AssetManager, com.jme3.renderer.RenderManager, java.util.EnumSet, com.jme3.light.LightList, com.jme3.shader.DefineList)}.
      * @param geometry The geometry to render
      * @param lights Lights which influence the geometry.
      */

jme3-core/src/main/java/com/jme3/math/Matrix4f.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -1740,7 +1740,7 @@ public final class Matrix4f implements Savable, Cloneable, java.io.Serializable
 	}
 
 	/**
-	 * Retreives the scale vector from the matrix.
+	 * Retrieves the scale vector from the matrix.
 	 * 
 	 * @return the scale vector
 	 */
@@ -1751,13 +1751,13 @@ public final class Matrix4f implements Savable, Cloneable, java.io.Serializable
 	}
 
     /**
-	 * Retreives the scale vector from the matrix and stores it into a given
+     * Retrieves the scale vector from the matrix and stores it into a given
      * vector.
      *
-	 * @param the
+     * @param store the vector where the scale will be stored
-	 *            vector where the scale will be stored
+     * @return the store vector
      */
-	public void toScaleVector(Vector3f vector) {
+    public Vector3f toScaleVector(Vector3f store) {
 		float scaleX = (float) Math.sqrt(m00 * m00 + m10 * m10 + m20 * m20);
 		float scaleY = (float) Math.sqrt(m01 * m01 + m11 * m11 + m21 * m21);
 		float scaleZ = (float) Math.sqrt(m02 * m02 + m12 * m12 + m22 * m22);

jme3-core/src/main/java/com/jme3/opencl/Context.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -87,7 +87,7 @@ public abstract class Context extends AbstractOpenCLObject {
      * memory size and so on, are queried over the Device instances.
      * <br>
      * The available devices were specified by a {@link PlatformChooser}.
-     * @return 
+     * @return a list of devices
      */
     public abstract List<? extends Device> getDevices();
 
@@ -184,10 +184,10 @@ public abstract class Context extends AbstractOpenCLObject {
      * <b>Note:</b> The vertex buffer must already been uploaded to the GPU,
      * i.e. it must be used at least once for drawing.
      * <p>
-     * Before the returned buffer can be used, it must be acquried explicitly
+     * Before the returned buffer can be used, it must be acquired explicitly
      * by {@link Buffer#acquireBufferForSharingAsync(com.jme3.opencl.CommandQueue) }
      * and after modifying it, released by {@link Buffer#releaseBufferForSharingAsync(com.jme3.opencl.CommandQueue) }.
-     * This is needed so that OpenGL and OpenCL operations do not interfer with each other.
+     * This is needed so that OpenGL and OpenCL operations do not interfere with each other.
      * @param vb the vertex buffer to share
      * @param access the memory access for the kernel
      * @return the new buffer
@@ -204,10 +204,10 @@ public abstract class Context extends AbstractOpenCLObject {
      * <b>Note:</b> The image must already been uploaded to the GPU,
      * i.e. it must be used at least once for drawing.
      * <p>
-     * Before the returned image can be used, it must be acquried explicitly
+     * Before the returned image can be used, it must be acquired explicitly
      * by {@link Image#acquireImageForSharingAsync(com.jme3.opencl.CommandQueue) }
      * and after modifying it, released by {@link Image#releaseImageForSharingAsync(com.jme3.opencl.CommandQueue) }
-     * This is needed so that OpenGL and OpenCL operations do not interfer with each other.
+     * This is needed so that OpenGL and OpenCL operations do not interfere with each other.
      * 
      * @param image the jME3 image object
      * @param textureType the texture type (1D, 2D, 3D), since this is not stored in the image
@@ -226,10 +226,10 @@ public abstract class Context extends AbstractOpenCLObject {
      * <b>Note:</b> The image must already been uploaded to the GPU,
      * i.e. it must be used at least once for drawing.
      * <p>
-     * Before the returned image can be used, it must be acquried explicitly
+     * Before the returned image can be used, it must be acquired explicitly
      * by {@link Image#acquireImageForSharingAsync(com.jme3.opencl.CommandQueue) }
      * and after modifying it, released by {@link Image#releaseImageForSharingAsync(com.jme3.opencl.CommandQueue) }
-     * This is needed so that OpenGL and OpenCL operations do not interfer with each other.
+     * This is needed so that OpenGL and OpenCL operations do not interfere with each other.
      * <p>
      * This method is equivalent to calling
      * {@code bindImage(texture.getImage(), texture.getType(), miplevel, access)}.
@@ -263,14 +263,14 @@ public abstract class Context extends AbstractOpenCLObject {
      * <b>Note:</b> The renderbuffer must already been uploaded to the GPU,
      * i.e. it must be used at least once for drawing.
      * <p>
-     * Before the returned image can be used, it must be acquried explicitly
+     * Before the returned image can be used, it must be acquired explicitly
      * by {@link Image#acquireImageForSharingAsync(com.jme3.opencl.CommandQueue) }
      * and after modifying it, released by {@link Image#releaseImageForSharingAsync(com.jme3.opencl.CommandQueue) }
-     * This is needed so that OpenGL and OpenCL operations do not interfer with each other.
+     * This is needed so that OpenGL and OpenCL operations do not interfere with each other.
      * 
      * @param buffer
      * @param access
-     * @return 
+     * @return an image
      */
     public Image bindRenderBuffer(FrameBuffer.RenderBuffer buffer, MemoryAccess access) {
         if (buffer.getTexture() == null) {

jme3-core/src/main/java/com/jme3/opencl/Device.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -155,7 +155,7 @@ public interface Device {
 	long getMaximumWorkItemDimensions();
     /**
      * Maximum number of work-items that can be specified in each dimension of the
-     * work-group to {@link Kernel#Run2(com.jme3.opencl.CommandQueue, com.jme3.opencl.WorkSize, com.jme3.opencl.WorkSize, java.lang.Object...) }.
+     * work-group to {@link Kernel#Run2(com.jme3.opencl.CommandQueue, com.jme3.opencl.Kernel.WorkSize, com.jme3.opencl.Kernel.WorkSize, java.lang.Object...)}.
      * The array has a length of at least 3.
      * @return the maximum size of the work group in each dimension
      */

jme3-core/src/main/java/com/jme3/opencl/Image.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2016 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -175,10 +175,10 @@ memory layout in which channels are stored in the image.
     /**
      * The image descriptor structure describes the type and dimensions of the image or image array.
      * <p>
-     * There exists two constructors:<br>
+     * There exist two constructors:<br>
-     * {@link #ImageDescriptor(com.jme3.opencl.Image.ImageType, long, long, long, long) }
+     * ImageDescriptor(ImageType, long, long, long, long)
      * is used when an image with new memory should be created (used most often).<br>
-     * {@link #ImageDescriptor(com.jme3.opencl.Image.ImageType, long, long, long, long, long, long, java.nio.ByteBuffer) }
+     * ImageDescriptor(ImageType, long, long, long, long, long, long, ByteBuffer)
      * creates an image using the provided {@code ByteBuffer} as source.
      */
     public static class ImageDescriptor { //Struct
@@ -270,12 +270,10 @@ memory layout in which channels are stored in the image.
     public abstract long getDepth();
     /**
      * @return the row pitch when the image was created from a host buffer
-     * @see ImageDescriptor#ImageDescriptor(com.jme3.opencl.Image.ImageType, long, long, long, long, long, long, java.nio.ByteBuffer) 
      */
     public abstract long getRowPitch();
     /**
      * @return the slice pitch when the image was created from a host buffer
-     * @see ImageDescriptor#ImageDescriptor(com.jme3.opencl.Image.ImageType, long, long, long, long, long, long, java.nio.ByteBuffer) 
      */
     public abstract long getSlicePitch();
     /**

jme3-core/src/main/java/com/jme3/opencl/KernelCompilationException.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2016 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -32,10 +32,10 @@
 package com.jme3.opencl;
 
 /**
- * This exception is thrown by {@link Program#build() } and {@link Program#build(java.lang.String) }
+ * This exception is thrown by {@link Program#build()}
  * when the compilation failed.
  * The error log returned by {@link #getLog() } contains detailed information
- * where the error occured.
+ * where the error occurred.
  * @author shaman
  */
 public class KernelCompilationException extends OpenCLException {
@@ -49,7 +49,7 @@ public class KernelCompilationException extends OpenCLException {
 
     /**
      * The output of the compiler
-     * @return 
+     * @return the output text
      */
 	public String getLog() {
 		return log;

jme3-core/src/main/java/com/jme3/opencl/Program.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2016 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -74,7 +74,6 @@ public abstract class Program extends AbstractOpenCLObject {
     /**
      * Builds this program without additional arguments
      * @throws KernelCompilationException if the compilation fails
-     * @see #build(java.lang.String) 
      */
 	public void build() throws KernelCompilationException {
         build("", (Device[]) null);
@@ -85,7 +84,7 @@ public abstract class Program extends AbstractOpenCLObject {
      * @param name the name of the kernel as defined in the source code
      * @return the kernel object
      * @throws OpenCLException if the kernel was not found or some other
-     * error occured
+     * error occurred
      */
 	public abstract Kernel createKernel(String name);
     

jme3-core/src/main/java/com/jme3/opencl/package-info.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -30,6 +30,7 @@
  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
+package com.jme3.opencl;
 /**
  * This package contains an API for using OpenCL together with jME3.
  * <p>
@@ -62,7 +63,8 @@
  * with the following syntax: {@code __kernel void KernelName(KernelArgs) {Code} }.
  * On the programming side, a {@link com.jme3.opencl.Kernel} instance is obtained
  * by calling {@link com.jme3.opencl.Program#createKernel(java.lang.String) }.
- * To execute the kernel, the method {@link com.jme3.opencl.Kernel#Run1(com.jme3.opencl.CommandQueue, com.jme3.opencl.WorkSize, java.lang.Object...) }
+ * To execute the kernel, the method
+ * {@link Kernel#Run1(com.jme3.opencl.CommandQueue, com.jme3.opencl.Kernel.WorkSize, java.lang.Object...)}
  * is provided. You first pass the command queue and the work size (i.e. the number of parallel executed threads)
  * followed by the kernel arguments.
  * <br>
@@ -77,8 +79,7 @@
  * of the buffer, the behavior is completely undefined and may often result in
  * a program cache later on.
  * {@link com.jme3.opencl.Image} objects are structured one, two or three dimensional
- * memory chunks of a fixed type. They are created by 
+ * memory chunks of a fixed type. They are created by Context.createImage().
- * {@link com.jme3.opencl.Context#createImage(com.jme3.opencl.MemoryAccess, com.jme3.opencl.Image.ImageFormat, com.jme3.opencl.Image.ImageDescriptor, java.nio.ByteBuffer) }.
  * They need special functions in the kernel code to write to or read from images.
  * Both buffer and image objects provide methods for copying between buffers and images,
  * reading and writing to host code and directly mapping memory parts to the host code.
@@ -158,6 +159,5 @@
  * OpenCL 1.2 and 2.0.
  * </ul>
  */
-package com.jme3.opencl;
 
 //TODO: add profiling to Kernel, CommandQueue

jme3-core/src/main/java/com/jme3/post/Filter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -221,7 +221,7 @@ public abstract class Filter implements Savable {
 
     /**
      * returns the default pass depth format
-     * @return
+     * @return the enum value
      */
     protected Format getDefaultPassDepthFormat() {
         return Format.Depth;
@@ -371,14 +371,14 @@ public abstract class Filter implements Savable {
 
     /**
      * returns the default pass frame buffer
-     * @return
+     * @return the pre-existing buffer
      */
     protected FrameBuffer getRenderFrameBuffer() {
         return defaultPass.renderFrameBuffer;
     }
 
     /**
-     * sets the default pas frame buffer
+     * sets the default pass frame buffer
      * @param renderFrameBuffer
      */
     protected void setRenderFrameBuffer(FrameBuffer renderFrameBuffer) {
@@ -387,7 +387,7 @@ public abstract class Filter implements Savable {
 
     /**
      * returns the rendered texture of this filter
-     * @return
+     * @return the pre-existing texture
      */
     protected Texture2D getRenderedTexture() {
         return defaultPass.renderedTexture;
@@ -434,7 +434,7 @@ public abstract class Filter implements Savable {
     
     /**
      * returns the list of the postRender passes
-     * @return
+     * @return the pre-existing List
      */
     protected List<Pass> getPostRenderPasses() {
         return postRenderPasses;

jme3-core/src/main/java/com/jme3/renderer/Caps.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -367,11 +367,12 @@ public enum Caps {
      * <p>
      * Use of NPOT textures is allowed iff:
      * <ul>
-     * <li>The {@link Texture.WrapMode} is set to 
+     * <li>The {@link com.jme3.texture.Texture.WrapMode} is set to 
-     * {@link Texture.WrapMode#EdgeClamp}.</li>
+     * {@link com.jme3.texture.Texture.WrapMode#EdgeClamp}.</li>
-     * <li>Mip-mapping is not used, meaning {@link Texture.MinFilter} is set to
+     * <li>Mip-mapping is not used, meaning 
-     * {@link Texture.MinFilter#BilinearNoMipMaps} or 
+     * {@link com.jme3.texture.Texture.MinFilter} is set to
-     * {@link Texture.MinFilter#NearestNoMipMaps}</li>
+     * {@link com.jme3.texture.Texture.MinFilter#BilinearNoMipMaps} or 
+     * {@link com.jme3.texture.Texture.MinFilter#NearestNoMipMaps}</li>
      * </ul>
      */
     PartialNonPowerOfTwoTextures,

jme3-core/src/main/java/com/jme3/renderer/RenderContext.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -167,19 +167,19 @@ public class RenderContext {
     /**
      * Currently bound element array vertex buffer.
      * 
-     * @see Renderer#renderMesh(com.jme3.scene.Mesh, int, int) 
+     * @see Renderer#renderMesh(com.jme3.scene.Mesh, int, int, com.jme3.scene.VertexBuffer[]) 
      */
     public int boundElementArrayVBO;
 
     /**
-     * @see Renderer#renderMesh(com.jme3.scene.Mesh, int, int) 
+     * @see Renderer#renderMesh(com.jme3.scene.Mesh, int, int, com.jme3.scene.VertexBuffer[]) 
      */
     public int boundVertexArray;
 
     /**
      * Currently bound array vertex buffer.
      * 
-     * @see Renderer#renderMesh(com.jme3.scene.Mesh, int, int) 
+     * @see Renderer#renderMesh(com.jme3.scene.Mesh, int, int, com.jme3.scene.VertexBuffer[]) 
      */
     public int boundArrayVBO;
     

jme3-core/src/main/java/com/jme3/renderer/RenderManager.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -541,7 +541,7 @@ public class RenderManager {
      * If a {@link #setForcedTechnique(java.lang.String) forced technique} is
      * set on this RenderManager, then it is selected automatically
      * on the geometry's material and is used for rendering. Otherwise, one
-     * of the {@link MaterialDef#getDefaultTechniques() default techniques} is
+     * of the {@link com.jme3.material.MaterialDef#getTechniqueDefsNames() default techniques} is
      * used.
      * <p>
      * If a {@link #setForcedRenderState(com.jme3.material.RenderState) forced
@@ -553,8 +553,8 @@ public class RenderManager {
        * 
      * @see Technique
      * @see RenderState
-     * @see Material#selectTechnique(java.lang.String, com.jme3.renderer.RenderManager) 
+     * @see com.jme3.material.Material#selectTechnique(java.lang.String, com.jme3.renderer.RenderManager) 
-     * @see Material#render(com.jme3.scene.Geometry, com.jme3.renderer.RenderManager) 
+     * @see com.jme3.material.Material#render(com.jme3.scene.Geometry, com.jme3.renderer.RenderManager) 
      */
     public void renderGeometry(Geometry geom) {
         if (geom.isIgnoreTransform()) {
@@ -690,7 +690,7 @@ public class RenderManager {
      * In addition to enqueuing the visible geometries, this method
      * also scenes which cast or receive shadows, by putting them into the
      * RenderQueue's 
-     * {@link RenderQueue#addToShadowQueue(com.jme3.scene.Geometry, com.jme3.renderer.queue.RenderQueue.ShadowMode) 
+     * {@link RenderQueue#addToQueue(com.jme3.scene.Geometry, com.jme3.renderer.queue.RenderQueue.Bucket) 
      * shadow queue}. Each Spatial which has its 
      * {@link Spatial#setShadowMode(com.jme3.renderer.queue.RenderQueue.ShadowMode) shadow mode}
      * set to not off, will be put into the appropriate shadow queue, note that
@@ -1048,7 +1048,7 @@ public class RenderManager {
      * (see {@link #renderTranslucentQueue(com.jme3.renderer.ViewPort) })</li>
      * <li>If any objects remained in the render queue, they are removed
      * from the queue. This is generally objects added to the 
-     * {@link RenderQueue#renderShadowQueue(com.jme3.renderer.queue.RenderQueue.ShadowMode, com.jme3.renderer.RenderManager, com.jme3.renderer.Camera, boolean) 
+     * {@link RenderQueue#renderQueue(com.jme3.renderer.queue.RenderQueue.Bucket, com.jme3.renderer.RenderManager, com.jme3.renderer.Camera) 
      * shadow queue}
      * which were not rendered because of a missing shadow renderer.</li>
      * </ul>

jme3-core/src/main/java/com/jme3/renderer/Renderer.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -366,14 +366,14 @@ public interface Renderer {
       * set shall undergo an sRGB to linear RGB color conversion when read by a shader.
       *
       * The conversion is performed for the following formats:
-      *  - {@link Image.Format#RGB8}
+      *  - {@link com.jme3.texture.Image.Format#RGB8}
-      *  - {@link Image.Format#RGBA8}
+      *  - {@link com.jme3.texture.Image.Format#RGBA8}
-      *  - {@link Image.Format#Luminance8}
+      *  - {@link com.jme3.texture.Image.Format#Luminance8}
-      *  - {@link Image.Format#Luminance8Alpha8}
+      *  - {@link com.jme3.texture.Image.Format#Luminance8Alpha8}
-      *  - {@link Image.Format#DXT1}
+      *  - {@link com.jme3.texture.Image.Format#DXT1}
-      *  - {@link Image.Format#DXT1A}
+      *  - {@link com.jme3.texture.Image.Format#DXT1A}
-      *  - {@link Image.Format#DXT3}
+      *  - {@link com.jme3.texture.Image.Format#DXT3}
-      *  - {@link Image.Format#DXT5}
+      *  - {@link com.jme3.texture.Image.Format#DXT5}
       * 
       * For all other formats, no conversion is performed.
       *

jme3-core/src/main/java/com/jme3/renderer/opengl/GLRenderer.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -2610,7 +2610,7 @@ public final class GLRenderer implements Renderer {
                 // OK: Works on all platforms.
                 break;
             case UnsignedInt:
-                // Requres extension on OpenGL ES 2.
+                // Requires extension on OpenGL ES 2.
                 if (!caps.contains(Caps.IntegerIndexBuffer)) {
                     throw new RendererException("32-bit index buffers are not supported by the video hardware");
                 }

jme3-core/src/main/java/com/jme3/scene/BatchNode.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -57,7 +57,7 @@ import com.jme3.util.clone.JmeCloneable;
  * The geometries are directly attached to the node in the scene graph.
  * Usage is like any other node except you have to call the {@link #batch()} method once all the geometries have been attached to the sub scene graph and their material set
  * (see todo more automagic for further enhancements)
- * All the geometries that have been batched are set to not be rendered - {@link CullHint} is left intact.
+ * All the geometries that have been batched are set to not be rendered - {@link Spatial.CullHint} is left intact.
  * The sub geometries can be transformed as usual, their transforms are used to update the mesh of the geometryBatch.
  * Sub geoms can be removed but it may be slower than the normal spatial removing
  * Sub geoms can be added after the batch() method has been called but won't be batched and will just be rendered as normal geometries.

jme3-core/src/main/java/com/jme3/scene/Geometry.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

jme3-core/src/main/java/com/jme3/scene/Mesh.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -1495,7 +1495,7 @@ public class Mesh implements Savable, Cloneable, JmeCloneable {
 
     /**
      * Gets the amount of vertices used for each patch;
-     * @return
+     * @return the count (≥0)
      */
     public int getPatchVertexCount() {
         return patchVertexCount;

jme3-core/src/main/java/com/jme3/scene/Spatial.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -157,7 +157,7 @@ public abstract class Spatial implements Savable, Cloneable, Collidable, Cloneab
     /**
      * Used for smart asset caching
      *
-     * @see AssetKey#useSmartCache()
+     * @see com.jme3.asset.AssetKey#getCacheType()
      */
     protected AssetKey key;
     /**

jme3-core/src/main/java/com/jme3/scene/mesh/IndexBuffer.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -84,7 +84,7 @@ public abstract class IndexBuffer {
     }
 
     /**
-     * @return
+     * @return the count (≥0)
      * @see Buffer#remaining()
      */
     public int remaining() {
@@ -94,7 +94,7 @@ public abstract class IndexBuffer {
     /**
      * Returns the vertex index for the current position.
      *
-     * @return
+     * @return the index
      */
     public abstract int get();
 
@@ -102,7 +102,7 @@ public abstract class IndexBuffer {
      * Returns the vertex index for the given index in the index buffer.
      * 
      * @param i The index inside the index buffer
-     * @return 
+     * @return the index
      */
     public abstract int get(int i);
     

jme3-core/src/main/java/com/jme3/scene/shape/Dome.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -80,7 +80,7 @@ public class Dome extends Mesh {
      *            Influences how round the base of the dome is.
      * @param radius
      *            Radius of the dome.
-     * @see #Dome(com.jme.math.Vector3f, int, int, float)
+     * @see #Dome(com.jme3.math.Vector3f, int, int, float)
      */
     public Dome(int planes, int radialSamples, float radius) {
         this(new Vector3f(0, 0, 0), planes, radialSamples, radius);

jme3-core/src/main/java/com/jme3/shader/Shader.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -215,7 +215,7 @@ public final class Shader extends NativeObject {
     }
 
     /**
-     * Creates a new shader, {@link #initialize() } must be called
+     * Creates a new shader, initialize() must be called
      * after this constructor for the shader to be usable.
      */
     public Shader(){

jme3-core/src/main/java/com/jme3/shader/ShaderNodeDefinition.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -170,7 +170,7 @@ public class ShaderNodeDefinition implements Savable {
 
     /**
      * return the path of this definition
-     * @return 
+     * @return the path
      */
     public String getPath() {
         return path;

jme3-core/src/main/java/com/jme3/shader/UniformBindingManager.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -43,7 +43,7 @@ import java.util.ArrayList;
  * <code>UniformBindingManager</code> helps {@link RenderManager} to manage
  * {@link UniformBinding uniform bindings}.
  * 
- * The {@link #updateUniformBindings(java.util.List) } will update
+ * The {@link #updateUniformBindings(com.jme3.shader.Shader)} method will update
  * a given list of uniforms based on the current state
  * of the manager.
  * 
@@ -223,8 +223,6 @@ public class UniformBindingManager {
      * Internal use only. Sets the world matrix to use for future
      * rendering. This has no effect unless objects are rendered manually
      * using {@link Material#render(com.jme3.scene.Geometry, com.jme3.renderer.RenderManager) }.
-     * Using {@link #renderGeometry(com.jme3.scene.Geometry) } will 
-     * override this value.
      * 
      * @param mat The world matrix to set
      */

jme3-core/src/main/java/com/jme3/shadow/AbstractShadowFilter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -74,8 +74,6 @@ public abstract class AbstractShadowFilter<T extends AbstractShadowRenderer> ext
      * @param manager the application asset manager
      * @param shadowMapSize the size of the rendered shadowmaps (512,1024,2048,
      * etc...)
-     * @param nbShadowMaps the number of shadow maps rendered (the more shadow
-     * maps the more quality, the less fps).
      * @param shadowRenderer the shadowRenderer to use for this Filter
      */
     @SuppressWarnings("all")
@@ -305,7 +303,7 @@ public abstract class AbstractShadowFilter<T extends AbstractShadowRenderer> ext
      * returns the edge filtering mode
      *
      * @see EdgeFilteringMode
-     * @return
+     * @return the enum value
      */
     public EdgeFilteringMode getEdgeFilteringMode() {
         return shadowRenderer.getEdgeFilteringMode();

jme3-core/src/main/java/com/jme3/shadow/AbstractShadowRenderer.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -245,7 +245,7 @@ public abstract class AbstractShadowRenderer implements SceneProcessor, Savable,
      * returns the edge filtering mode
      *
      * @see EdgeFilteringMode
-     * @return
+     * @return the enum value
      */
     public EdgeFilteringMode getEdgeFilteringMode() {
         return edgeFilteringMode;
@@ -367,7 +367,7 @@ public abstract class AbstractShadowRenderer implements SceneProcessor, Savable,
      *
      * @param shadowMapIndex the index of the shadow map being rendered
      * @param shadowMapOccluders the list of occluders
-     * @return
+     * @return the geometryList
      */
     protected abstract GeometryList getOccludersToRender(int shadowMapIndex, GeometryList shadowMapOccluders);
 

jme3-core/src/main/java/com/jme3/shadow/BasicShadowRenderer.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -117,7 +117,7 @@ public class BasicShadowRenderer implements SceneProcessor {
 
     /**
      * returns the light direction used for this processor
-     * @return 
+     * @return the pre-existing vector
      */
     public Vector3f getDirection() {
         return direction;
@@ -133,7 +133,7 @@ public class BasicShadowRenderer implements SceneProcessor {
 
     /**
      * debug only
-     * @return 
+     * @return the pre-existing array
      */
     public Vector3f[] getPoints() {
         return points;
@@ -142,7 +142,7 @@ public class BasicShadowRenderer implements SceneProcessor {
     /**
      * debug only
      * returns the shadow camera 
-     * @return 
+     * @return the pre-existing camera
      */
     public Camera getShadowCamera() {
         return shadowCam;
@@ -202,7 +202,7 @@ public class BasicShadowRenderer implements SceneProcessor {
 
     /**
      * debug only
-     * @return 
+     * @return the pre-existing instance
      */
     public Picture getDisplayPicture() {
         return dispPic;

jme3-core/src/main/java/com/jme3/shadow/DirectionalLightShadowFilter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -126,7 +126,7 @@ public class DirectionalLightShadowFilter extends AbstractShadowFilter<Direction
 
     /**
      * returns true if stabilization is enabled
-     * @return 
+     * @return true if stabilization is enabled
      */
     public boolean isEnabledStabilization() {
         return shadowRenderer.isEnabledStabilization();

jme3-core/src/main/java/com/jme3/shadow/DirectionalLightShadowRenderer.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -304,7 +304,7 @@ public class DirectionalLightShadowRenderer extends AbstractShadowRenderer {
     /**
      * Directional light are always in the view frustum
      * @param viewCam
-     * @return 
+     * @return true
      */
     @Override
     protected boolean checkCulling(Camera viewCam) {

jme3-core/src/main/java/com/jme3/shadow/PointLightShadowRenderer.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -227,7 +227,7 @@ public class PointLightShadowRenderer extends AbstractShadowRenderer {
     /**
      *
      * @param viewCam
-     * @return 
+     * @return true if intersects
      */
     @Override
     protected boolean checkCulling(Camera viewCam) {

jme3-core/src/main/java/com/jme3/shadow/PssmShadowFilter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -135,7 +135,7 @@ public class PssmShadowFilter extends Filter {
 
     /**
      * returns the light direction used by the processor
-     * @return 
+     * @return a direction vector
      */
     public Vector3f getDirection() {
         return pssmRenderer.getDirection();
@@ -172,7 +172,7 @@ public class PssmShadowFilter extends Filter {
 
     /**
      * How far the shadows are rendered in the view
-     * @see setShadowZExtend(float zFar)
+     * @see #setShadowZExtend(float zFar)
      * @return shadowZExtend
      */
     public float getShadowZExtend() {

jme3-core/src/main/java/com/jme3/shadow/PssmShadowRenderer.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -186,9 +186,7 @@ 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).
+     * the more quality, the less fps)
-     * @param nbSplits the number of shadow maps rendered (the more shadow maps
-     * the more quality, the less fps).
      */
     public PssmShadowRenderer(AssetManager manager, int size, int nbSplits) {
         this(manager, size, nbSplits, new Material(manager, "Common/MatDefs/Shadow/PostShadow.j3md"));
@@ -367,7 +365,7 @@ public class PssmShadowRenderer implements SceneProcessor {
     /**
      * returns the light direction used by the processor
      *
-     * @return
+     * @return the pre-existing vector
      */
     public Vector3f getDirection() {
         return direction;

jme3-core/src/main/java/com/jme3/shadow/PssmShadowUtil.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -42,7 +42,7 @@ import static java.lang.Math.min;
 /**
  * Includes various useful shadow mapping functions.
  *
- * @see
+ * See
  * <ul>
  * <li><a href="http://appsrv.cse.cuhk.edu.hk/~fzhang/pssm_vrcia/">http://appsrv.cse.cuhk.edu.hk/~fzhang/pssm_vrcia/</a></li>
  * <li><a href="http://http.developer.nvidia.com/GPUGems3/gpugems3_ch10.html">http://http.developer.nvidia.com/GPUGems3/gpugems3_ch10.html</a></li>

jme3-core/src/main/java/com/jme3/shadow/ShadowUtil.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -53,7 +53,7 @@ import java.util.List;
 /**
  * Includes various useful shadow mapping functions.
  *
- * @see <ul> <li><a
+ * See <ul> <li><a
  * href="http://appsrv.cse.cuhk.edu.hk/~fzhang/pssm_vrcia/">http://appsrv.cse.cuhk.edu.hk/~fzhang/pssm_vrcia/</a></li>
  * <li><a
  * href="http://http.developer.nvidia.com/GPUGems3/gpugems3_ch10.html">http://http.developer.nvidia.com/GPUGems3/gpugems3_ch10.html</a></li>
@@ -171,7 +171,7 @@ public class ShadowUtil {
      * Compute bounds of a geomList
      * @param list
      * @param transform
-     * @return
+     * @return a new instance
      */
     public static BoundingBox computeUnionBound(GeometryList list, Transform transform) {
         BoundingBox bbox = new BoundingBox();
@@ -192,7 +192,7 @@ public class ShadowUtil {
      * Compute bounds of a geomList
      * @param list
      * @param mat
-     * @return
+     * @return a new instance
      */
     public static BoundingBox computeUnionBound(GeometryList list, Matrix4f mat) {
         BoundingBox bbox = new BoundingBox();
@@ -213,7 +213,7 @@ public class ShadowUtil {
      * Computes the bounds of multiple bounding volumes
      *
      * @param bv
-     * @return
+     * @return a new instance
      */
     public static BoundingBox computeUnionBound(List<BoundingVolume> bv) {
         BoundingBox bbox = new BoundingBox();
@@ -229,7 +229,7 @@ public class ShadowUtil {
      *
      * @param pts
      * @param transform
-     * @return
+     * @return a new instance
      */
     public static BoundingBox computeBoundForPoints(Vector3f[] pts, Transform transform) {
         Vector3f min = new Vector3f(Vector3f.POSITIVE_INFINITY);
@@ -250,7 +250,7 @@ public class ShadowUtil {
      * Compute bounds from an array of points
      * @param pts
      * @param mat
-     * @return
+     * @return a new BoundingBox
      */
     public static BoundingBox computeBoundForPoints(Vector3f[] pts, Matrix4f mat) {
         Vector3f min = new Vector3f(Vector3f.POSITIVE_INFINITY);
@@ -718,7 +718,8 @@ public class ShadowUtil {
      * of OccludersExtractor.rootScene node that are both in the frustum of the given vpCamera and some camera inside cameras array.
      * The array of cameras must be initialized to represent the light viewspace of some light like pointLight or spotLight
      *
-     * @param camera the viewPort camera 
+     * @param rootScene
+     * @param vpCamera the viewPort camera 
      * @param cameras the camera array to check geometries against, representing the light viewspace
      * @param outputGeometryList the output list of all geometries that are in the camera frustum
      */

jme3-core/src/main/java/com/jme3/shadow/SpotLightShadowRenderer.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -224,7 +224,7 @@ public class SpotLightShadowRenderer extends AbstractShadowRenderer {
     /**
      *
      * @param viewCam
-     * @return 
+     * @return true if intersects, otherwise false
      */
     @Override
     protected boolean checkCulling(Camera viewCam) {      

jme3-core/src/main/java/com/jme3/system/AppSettings.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -816,7 +816,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)

jme3-core/src/main/java/com/jme3/system/JmeContext.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -58,9 +58,9 @@ public interface JmeContext {
 
         /**
          * A canvas type context makes a rendering surface available as an
-         * AWT {@link java.awt.Canvas} object that can be embedded in a Swing/AWT
+         * AWT Canvas object that can be embedded in a Swing/AWT
          * frame. To retrieve the Canvas object, you should cast the context
-         * to {@link JmeCanvasContext}.
+         * to JmeCanvasContext.
          */
         Canvas,
 

jme3-core/src/main/java/com/jme3/system/JmeSystem.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -125,7 +125,7 @@ public class JmeSystem {
      * 
      * @param outStream The stream where to write the image data.
      * @param format The format to use, either "png" or "jpg".
-     * @param imageData The image data in {@link Image.Format#RGBA8} format.
+     * @param imageData The image data in {@link com.jme3.texture.Image.Format#RGBA8} format.
      * @param width The width of the image.
      * @param height The height of the image.
      * @throws IOException If outStream throws an exception while writing.

jme3-core/src/main/java/com/jme3/system/SystemListener.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -81,8 +81,8 @@ public interface SystemListener {
     public void loseFocus();
 
     /**
-     * Called when an error has occured. This is typically
+     * Called when an error has occurred. This is typically
-     * invoked when an uncought exception is thrown in the render thread.
+     * invoked when an uncaught exception is thrown in the render thread.
      * @param errorMsg The error message, if any, or null.
      * @param t Throwable object, or null.
      */

jme3-core/src/main/java/com/jme3/texture/FrameBuffer.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -56,7 +56,7 @@ import java.util.ArrayList;
  * depth testing (which requires a depth buffer). 
  * Buffers can be copied to other framebuffers
  * including the main screen, by using 
- * {@link Renderer#copyFrameBuffer(com.jme3.texture.FrameBuffer, com.jme3.texture.FrameBuffer) }.
+ * {@link Renderer#copyFrameBuffer(com.jme3.texture.FrameBuffer, com.jme3.texture.FrameBuffer, boolean)}.
  * The content of a {@link RenderBuffer} can be retrieved by using 
  * {@link Renderer#readFrameBuffer(com.jme3.texture.FrameBuffer, java.nio.ByteBuffer) }.
  * <p>
@@ -510,7 +510,7 @@ public class FrameBuffer extends NativeObject {
     }
 
     /**
-     * @return The color buffer with the index set by {@link #setTargetIndex(int), or null
+     * @return The color buffer with the index set by {@link #setTargetIndex(int)}, or null
      * if no color buffers are attached.
 	 * If MRT is disabled, the first color buffer is returned.
      */
@@ -600,15 +600,14 @@ public class FrameBuffer extends NativeObject {
      * Specifies that the color values stored in this framebuffer are in SRGB
      * format.
      *
-     * The FrameBuffer must have a texture attached with the flag
+     * The FrameBuffer must have an SRGB texture attached.
-     * {@link Image#isSrgb()} set to true.
      *
      * The Renderer must expose the {@link Caps#Srgb sRGB pipeline} capability
      * for this option to take any effect.
      *
      * Rendering operations performed on this framebuffer shall undergo a linear
      * -&gt; sRGB color space conversion when this flag is enabled. If
-     * {@link RenderState#getBlendMode() blending} is enabled, it will be
+     * {@link com.jme3.material.RenderState#getBlendMode() blending} is enabled, it will be
      * performed in linear space by first decoding the stored sRGB pixel values
      * into linear, combining with the shader result, and then converted back to
      * sRGB upon being written into the framebuffer.
@@ -616,7 +615,7 @@ public class FrameBuffer extends NativeObject {
      * @param srgb If the framebuffer color values should be stored in sRGB
      * color space.
      *
-     * @throws InvalidStateException If the texture attached to this framebuffer
+     * @throws IllegalStateException If the texture attached to this framebuffer
      * is not sRGB.
      */
     public void setSrgb(boolean srgb) {
@@ -626,7 +625,7 @@ public class FrameBuffer extends NativeObject {
     /**
      * Determines if this framebuffer contains SRGB data.
      *
-     * @returns True if the framebuffer color values are in SRGB space, false if
+     * @return True if the framebuffer color values are in SRGB space, false if
      * in linear space.
      */
     public boolean isSrgb() {

jme3-core/src/main/java/com/jme3/texture/Image.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -735,7 +735,7 @@ public class Image extends NativeObject implements Savable /*, Cloneable*/ {
     }
 
     /**
-     * @see {@link #Image(com.jme3.texture.Image.Format, int, int, int, java.util.ArrayList, int[], com.jme3.texture.image.ColorSpace)}
+     * @see #Image(com.jme3.texture.Image.Format, int, int, int, java.util.ArrayList, int[], com.jme3.texture.image.ColorSpace)
      * @param format
      * @param width
      * @param height
@@ -791,7 +791,7 @@ public class Image extends NativeObject implements Savable /*, Cloneable*/ {
     }
     
     /**
-     * @see {@link #Image(com.jme3.texture.Image.Format, int, int, java.nio.ByteBuffer, int[], com.jme3.texture.image.ColorSpace)}
+     * @see #Image(com.jme3.texture.Image.Format, int, int, java.nio.ByteBuffer, int[], com.jme3.texture.image.ColorSpace)
      * @param format
      * @param width
      * @param height
@@ -825,7 +825,7 @@ public class Image extends NativeObject implements Savable /*, Cloneable*/ {
     }
     
     /**
-     * @see {@link #Image(com.jme3.texture.Image.Format, int, int, int, java.util.ArrayList, com.jme3.texture.image.ColorSpace)}
+     * @see #Image(com.jme3.texture.Image.Format, int, int, int, java.util.ArrayList, com.jme3.texture.image.ColorSpace)
      * @param format
      * @param width
      * @param height
@@ -859,7 +859,7 @@ public class Image extends NativeObject implements Savable /*, Cloneable*/ {
     
     
     /**
-     * @see {@link #Image(com.jme3.texture.Image.Format, int, int, java.nio.ByteBuffer, com.jme3.texture.image.ColorSpace)}
+     * @see #Image(com.jme3.texture.Image.Format, int, int, java.nio.ByteBuffer, com.jme3.texture.image.ColorSpace)
      * @param format
      * @param width
      * @param height
@@ -1130,7 +1130,7 @@ public class Image extends NativeObject implements Savable /*, Cloneable*/ {
      * @param colorSpace @see ColorSpace. Set to sRGB to enable srgb -> linear 
      * conversion, Linear otherwise.
      *
-     * @seealso Renderer#setLinearizeSrgbImages(boolean)
+     * @see Renderer#setLinearizeSrgbImages(boolean)
      *
      */
     public void setColorSpace(ColorSpace colorSpace) {
@@ -1148,7 +1148,7 @@ public class Image extends NativeObject implements Savable /*, Cloneable*/ {
      *
      * @return True, if the image is an SRGB image, false if it is linear RGB.
      *
-     * @seealso Renderer#setLinearizeSrgbImages(boolean)
+     * @see Renderer#setLinearizeSrgbImages(boolean)
      */
     public ColorSpace getColorSpace() {
         return colorSpace;

jme3-core/src/main/java/com/jme3/texture/image/ImageRaster.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -39,7 +39,7 @@ import com.jme3.texture.Image;
  * <br>
  * Allows directly manipulating pixels of the image by writing and 
  * reading {@link ColorRGBA colors} at any coordinate, without
- * regard to the underlying {@link Image.Format format} of the image.
+ * regard to the underlying {@link com.jme3.texture.Image.Format format} of the image.
  * NOTE: compressed and depth formats are <strong>not supported</strong>.
  * Special RGB formats like RGB111110F and RGB9E5 are not supported
  * at the moment, but may be added later on. For now 
@@ -135,7 +135,7 @@ public abstract class ImageRaster {
      * lower than 0.0 are still not allowed (as all formats are unsigned).
      * <p>
      * If the underlying format is grayscale (e.g. one of the luminance formats,
-     * such as {@link Image.Format#Luminance8}) then a color to grayscale
+     * such as {@link com.jme3.texture.Image.Format#Luminance8}) then a color to grayscale
      * conversion is done first, before writing the result into the image.
      * <p>
      * If the image does not have some of the components in the color (such
@@ -159,7 +159,7 @@ public abstract class ImageRaster {
      * <p>
      * Any components that are not defined in the image format
      * will be set to 1.0 in the returned color. For example,
-     * reading from an {@link Image.Format#Alpha8} format will
+     * reading from an {@link com.jme3.texture.Image.Format#Alpha8} format will
      * return a ColorRGBA with the R, G, and B components set to 1.0, and
      * the A component set to the alpha in the image.
      * <p>
@@ -169,7 +169,7 @@ public abstract class ImageRaster {
      * Integer formats are converted to the range 0.0 - 1.0, based
      * on the maximum possible integer value that can be represented
      * by the number of bits the component has.
-     * For example, the {@link Image.Format#RGB5A1} format can
+     * For example, the {@link com.jme3.texture.Image.Format#RGB5A1} format can
      * contain the integer values 0 - 31, a conversion to floating point
      * is done by diving the integer value by 31 (done with floating point
      * precision).

jme3-core/src/main/java/com/jme3/util/NativeObject.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -79,10 +79,8 @@ public abstract class NativeObject implements Cloneable {
     protected boolean updateNeeded = true;
 
     /**
-     * Creates a new GLObject with the given type. Should be
+     * Creates a new GLObject. Should be
      * called by the subclasses.
-     * 
-     * @param type The type that the subclass represents.
      */
     public NativeObject(){
         this.handleRef = new Object();

jme3-core/src/main/java/com/jme3/util/SkyFactory.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -61,7 +61,7 @@ public class SkyFactory {
     public enum EnvMapType{
         /**
          * The env map is a cube map see {@link TextureCubeMap} or 6 separate images that form a cube map
-         * The texture is either a {@link TextureCubeMap} or 6 {@link Texture2D}. 
+         * The texture is either a {@link TextureCubeMap} or 6 {@link com.jme3.texture.Texture2D}. 
          * In the latter case, a TextureCubeMap is build from the 6 2d maps.
          */
         CubeMap,
@@ -151,7 +151,7 @@ public class SkyFactory {
      * frustum
      * @return a new spatial representing the sky, ready to be attached to the
      * scene graph
-     * @deprecated use {@link SkyFactory#createSky(com.jme3.asset.AssetManager, com.jme3.texture.Texture, com.jme3.math.Vector3f, com.jme3.util.SkyFactory.EnvMapType, int)}
+     * @deprecated use {@link #createSky(com.jme3.asset.AssetManager, com.jme3.texture.Texture, com.jme3.math.Vector3f, com.jme3.util.SkyFactory.EnvMapType, float)}
      */
     @Deprecated
     public static Spatial createSky(AssetManager assetManager, Texture texture,
@@ -253,7 +253,7 @@ public class SkyFactory {
     * </ul> 
     * @return a new spatial representing the sky, ready to be attached to the
     * scene graph
-    * @deprecated use {@link SkyFactory#createSky(com.jme3.asset.AssetManager, java.lang.String, com.jme3.math.Vector3f, com.jme3.util.SkyFactory.EnvMapType)}
+    * @deprecated use {@link #createSky(com.jme3.asset.AssetManager, java.lang.String, com.jme3.util.SkyFactory.EnvMapType)}
     */  
     @Deprecated
     public static Spatial createSky(AssetManager assetManager, String textureName, boolean sphereMap) {

jme3-core/src/main/java/com/jme3/util/mikktspace/MikkTSpaceContext.java

@@ -15,7 +15,7 @@ public interface MikkTSpaceContext {
      * Returns the number of faces (triangles/quads) on the mesh to be
      * processed.
      *
-     * @return
+     * @return the count (≥0)
      */
     public int getNumFaces();
 
@@ -24,7 +24,7 @@ public interface MikkTSpaceContext {
      * the range {0, 1, ..., getNumFaces()-1}
      *
      * @param face
-     * @return
+     * @return the count (≥0)
      */
     public int getNumVerticesOfFace(int face);
 

jme3-core/src/main/java/com/jme3/util/xml/SAXUtil.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -47,7 +47,7 @@ public final class SAXUtil {
      * 
      * @param i The string to parse
      * @param def The default value if the string is null
-     * @return
+     * @return the parsed value or def
      * @throws SAXException 
      */
     public static int parseInt(String i, int def) throws SAXException{

jme3-core/src/plugins/java/com/jme3/texture/plugins/DDSLoader.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2019 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -446,7 +446,7 @@ public class DDSLoader implements AssetLoader {
      * @param flip Flip the loaded image by Y axis
      * @param totalSize Total size of the image in bytes including the mipmaps
      * @return A ByteBuffer containing the grayscale image data with mips.
-     * @throws java.io.IOException If an error occured while reading from InputStream
+     * @throws java.io.IOException If an error occurred while reading from InputStream
      */
     public ByteBuffer readGrayscale2D(boolean flip, int totalSize) throws IOException {
         ByteBuffer buffer = BufferUtils.createByteBuffer(totalSize);
@@ -481,7 +481,7 @@ public class DDSLoader implements AssetLoader {
      * @param flip Flip the image on the Y axis
      * @param totalSize Size of the image in bytes including mipmaps
      * @return ByteBuffer containing image data with mipmaps in the format specified by pixelFormat_
-     * @throws java.io.IOException If an error occured while reading from InputStream
+     * @throws java.io.IOException If an error occurred while reading from InputStream
      */
     public ByteBuffer readRGB2D(boolean flip, int totalSize) throws IOException {
         int redCount = count(redMask),
@@ -547,7 +547,7 @@ public class DDSLoader implements AssetLoader {
      *
      * @param totalSize Total size of the image in bytes, including mipmaps
      * @return ByteBuffer containing compressed DXT image in the format specified by pixelFormat_
-     * @throws java.io.IOException If an error occured while reading from InputStream
+     * @throws java.io.IOException If an error occurred while reading from InputStream
      */
     public ByteBuffer readDXT2D(boolean flip, int totalSize) throws IOException {
         logger.finest("Source image format: DXT");
@@ -584,7 +584,7 @@ public class DDSLoader implements AssetLoader {
      * @param flip Flip the loaded image by Y axis
      * @param totalSize Total size of the image in bytes including the mipmaps
      * @return A ByteBuffer containing the grayscale image data with mips.
-     * @throws java.io.IOException If an error occured while reading from InputStream
+     * @throws java.io.IOException If an error occurred while reading from InputStream
      */
     public ByteBuffer readGrayscale3D(boolean flip, int totalSize) throws IOException {
         ByteBuffer buffer = BufferUtils.createByteBuffer(totalSize * depth);
@@ -622,7 +622,7 @@ public class DDSLoader implements AssetLoader {
      * @param flip Flip the image on the Y axis
      * @param totalSize Size of the image in bytes including mipmaps
      * @return ByteBuffer containing image data with mipmaps in the format specified by pixelFormat_
-     * @throws java.io.IOException If an error occured while reading from InputStream
+     * @throws java.io.IOException If an error occurred while reading from InputStream
      */
     public ByteBuffer readRGB3D(boolean flip, int totalSize) throws IOException {
         int redCount = count(redMask),
@@ -690,7 +690,7 @@ public class DDSLoader implements AssetLoader {
      *
      * @param totalSize Total size of the image in bytes, including mipmaps
      * @return ByteBuffer containing compressed DXT image in the format specified by pixelFormat_
-     * @throws java.io.IOException If an error occured while reading from InputStream
+     * @throws java.io.IOException If an error occurred while reading from InputStream
      */
     public ByteBuffer readDXT3D(boolean flip, int totalSize) throws IOException {
         logger.finest("Source image format: DXT");
@@ -738,7 +738,7 @@ public class DDSLoader implements AssetLoader {
      * @return An ArrayList containing a single ByteBuffer for a 2D image, or 6 ByteBuffers for a cubemap.
      *         The cubemap ByteBuffer order is PositiveX, NegativeX, PositiveY, NegativeY, PositiveZ, NegativeZ.
      *
-     * @throws java.io.IOException If an error occured while reading from the stream.
+     * @throws java.io.IOException If an error occurred while reading from the stream.
      */
     public ArrayList<ByteBuffer> readData(boolean flip) throws IOException {
         int totalSize = 0;

jme3-core/src/tools/java/jme3tools/shadercheck/Validator.java

@@ -18,14 +18,15 @@ public interface Validator {
     public boolean isInstalled();
 
     /**
-     * Returns the tool version as a string, must return null if the tool
+     * @return the tool version as a String, must return null if the tool
      * is not installed.
      */
     public String getInstalledVersion();
     
     /**
      * Validates the given shader to make sure it follows all requirements
-     * of the shader language specified as {@link Shader#getLanguage() }.
+     * of the shader language specified as
+     * {@link com.jme3.shader.Shader.ShaderSource#getLanguage()}.
      * The results of the validation will be written into the 
      * results argument.
      *