diff --git a/jme3-core/src/main/java/checkers/quals/SubtypeOf.java b/jme3-core/src/main/java/checkers/quals/SubtypeOf.java index ffc8be045..189969c05 100644 --- a/jme3-core/src/main/java/checkers/quals/SubtypeOf.java +++ b/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 - * {@link checkers.types.TypeHierarchy}.) + * procedurally by subclassing checkers.types.QualifierHierarchy or + * checkers.types.TypeHierarchy.) * *

* Example: diff --git a/jme3-core/src/main/java/checkers/quals/package-info.java b/jme3-core/src/main/java/checkers/quals/package-info.java index 5ae80a7d6..192a8312f 100644 --- a/jme3-core/src/main/java/checkers/quals/package-info.java +++ b/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; diff --git a/jme3-core/src/main/java/com/jme3/anim/Armature.java b/jme3-core/src/main/java/com/jme3/anim/Armature.java index ad7f5b0ac..2424e9d34 100644 --- a/jme3-core/src/main/java/com/jme3/anim/Armature.java +++ b/jme3-core/src/main/java/com/jme3/anim/Armature.java @@ -83,7 +83,9 @@ public class Armature implements JmeCloneable, Savable { * Default is {@link MatrixJointModelTransform} * * @param modelTransformClass - * @see {@link JointModelTransform},{@link MatrixJointModelTransform},{@link SeparateJointModelTransform}, + * @see JointModelTransform + * @see MatrixJointModelTransform + * @see SeparateJointModelTransform */ public void setModelTransformClass(Class modelTransformClass) { this.modelTransformClass = modelTransformClass; @@ -106,7 +108,7 @@ public class Armature implements JmeCloneable, Savable { /** * returns the array of all root joints of this Armature * - * @return + * @return the pre-existing array */ public Joint[] getRoots() { return rootJoints; @@ -120,7 +122,7 @@ public class Armature implements JmeCloneable, Savable { * return a joint for the given index * * @param index - * @return + * @return the pre-existing instance */ public Joint getJoint(int index) { return jointList[index]; @@ -130,7 +132,7 @@ public class Armature implements JmeCloneable, Savable { * returns the joint with the given name * * @param name - * @return + * @return the pre-existing instance or null if not found */ public Joint getJoint(String name) { for (int i = 0; i < jointList.length; i++) { @@ -145,7 +147,7 @@ public class Armature implements JmeCloneable, Savable { * returns the bone index of the given bone * * @param joint - * @return + * @return the index (≥0) or -1 if not found */ public int getJointIndex(Joint joint) { for (int i = 0; i < jointList.length; i++) { @@ -161,7 +163,7 @@ public class Armature implements JmeCloneable, Savable { * returns the joint index of the joint that has the given name * * @param name - * @return + * @return the index (≥0) or -1 if not found */ public int getJointIndex(String name) { for (int i = 0; i < jointList.length; i++) { @@ -219,7 +221,7 @@ public class Armature implements JmeCloneable, Savable { /** * Compute the skinning matrices for each bone of the armature that would be used to transform vertices of associated meshes * - * @return + * @return the pre-existing array */ public Matrix4f[] computeSkinningMatrices() { for (int i = 0; i < jointList.length; i++) { @@ -231,7 +233,7 @@ public class Armature implements JmeCloneable, Savable { /** * returns the number of joints of this armature * - * @return + * @return the count (≥0) */ public int getJointCount() { return jointList.length; diff --git a/jme3-core/src/main/java/com/jme3/anim/MorphTrack.java b/jme3-core/src/main/java/com/jme3/anim/MorphTrack.java index 5056794f2..a72456c72 100644 --- a/jme3-core/src/main/java/com/jme3/anim/MorphTrack.java +++ b/jme3-core/src/main/java/com/jme3/anim/MorphTrack.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 @@ -77,7 +77,7 @@ public class MorphTrack implements AnimTrack { /** * return the array of weights of this track * - * @return + * @return the pre-existing array */ public float[] getWeights() { return weights; @@ -86,7 +86,7 @@ public class MorphTrack implements AnimTrack { /** * returns the arrays of time for this track * - * @return + * @return the pre-existing array */ public float[] getTimes() { return times; diff --git a/jme3-core/src/main/java/com/jme3/anim/SkinningControl.java b/jme3-core/src/main/java/com/jme3/anim/SkinningControl.java index 097840e81..02f480825 100644 --- a/jme3-core/src/main/java/com/jme3/anim/SkinningControl.java +++ b/jme3-core/src/main/java/com/jme3/anim/SkinningControl.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2009-2017 jMonkeyEngine + * Copyright (c) 2009-2019 jMonkeyEngine * All rights reserved. * * Redistribution and use in source and binary forms, with or without @@ -409,7 +409,7 @@ public class SkinningControl extends AbstractControl implements Cloneable, JmeCl /** * returns the armature of this control * - * @return + * @return the pre-existing instance */ public Armature getArmature() { return armature; diff --git a/jme3-core/src/main/java/com/jme3/anim/TransformTrack.java b/jme3-core/src/main/java/com/jme3/anim/TransformTrack.java index 94afdd7fb..29354fead 100644 --- a/jme3-core/src/main/java/com/jme3/anim/TransformTrack.java +++ b/jme3-core/src/main/java/com/jme3/anim/TransformTrack.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 @@ -82,7 +82,7 @@ public class TransformTrack implements AnimTrack { /** * return the array of rotations of this track * - * @return + * @return an array */ public Quaternion[] getRotations() { return rotations.toObjectArray(); @@ -91,7 +91,7 @@ public class TransformTrack implements AnimTrack { /** * returns the array of scales for this track * - * @return + * @return an array or null */ public Vector3f[] getScales() { return scales == null ? null : scales.toObjectArray(); @@ -100,7 +100,7 @@ public class TransformTrack implements AnimTrack { /** * returns the arrays of time for this track * - * @return + * @return the pre-existing array */ public float[] getTimes() { return times; @@ -109,7 +109,7 @@ public class TransformTrack implements AnimTrack { /** * returns the array of translations of this track * - * @return + * @return an array */ public Vector3f[] getTranslations() { return translations.toObjectArray(); diff --git a/jme3-core/src/main/java/com/jme3/animation/Animation.java b/jme3-core/src/main/java/com/jme3/animation/Animation.java index 834595238..d3a4d42f1 100644 --- a/jme3-core/src/main/java/com/jme3/animation/Animation.java +++ b/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 @@ -194,7 +194,7 @@ public class Animation implements Savable, Cloneable, JmeCloneable { /** * * @param spat - * @return + * @return a new instance */ public Animation cloneForSpatial(Spatial spat) { try { diff --git a/jme3-core/src/main/java/com/jme3/animation/AnimationUtils.java b/jme3-core/src/main/java/com/jme3/animation/AnimationUtils.java index 2254638e7..f7f2c54dd 100644 --- a/jme3-core/src/main/java/com/jme3/animation/AnimationUtils.java +++ b/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) { diff --git a/jme3-core/src/main/java/com/jme3/animation/AudioTrack.java b/jme3-core/src/main/java/com/jme3/animation/AudioTrack.java index 300287c1e..1f9df35e6 100644 --- a/jme3-core/src/main/java/com/jme3/animation/AudioTrack.java +++ b/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 @@ -158,7 +158,7 @@ public class AudioTrack implements ClonableTrack { /** * Clone this track * - * @return + * @return a new track */ @Override public Track clone() { diff --git a/jme3-core/src/main/java/com/jme3/animation/Bone.java b/jme3-core/src/main/java/com/jme3/animation/Bone.java index edc1b8894..6c99e5b99 100644 --- a/jme3-core/src/main/java/com/jme3/animation/Bone.java +++ b/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 @@ -961,7 +961,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; diff --git a/jme3-core/src/main/java/com/jme3/animation/BoneTrack.java b/jme3-core/src/main/java/com/jme3/animation/BoneTrack.java index a39108c5a..3d613984c 100644 --- a/jme3-core/src/main/java/com/jme3/animation/BoneTrack.java +++ b/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 @@ -44,7 +44,7 @@ import java.util.BitSet; * Contains a list of transforms and times for each keyframe. * * @author Kirill Vainer - * @deprecated use {@link com.jme3.anim.JointTrack} + * @deprecated use {@link com.jme3.anim.AnimTrack} */ @Deprecated public final class BoneTrack implements JmeCloneable, Track { @@ -110,7 +110,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(); @@ -118,7 +118,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(); @@ -126,7 +126,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; @@ -134,7 +134,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(); diff --git a/jme3-core/src/main/java/com/jme3/animation/CompactArray.java b/jme3-core/src/main/java/com/jme3/animation/CompactArray.java index b64e0785c..54516145a 100644 --- a/jme3-core/src/main/java/com/jme3/animation/CompactArray.java +++ b/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 @@ -131,7 +131,7 @@ public abstract class CompactArray 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(); @@ -141,7 +141,7 @@ public abstract class CompactArray implements JmeCloneable { /** * return a float array of serialized data - * @return + * @return the pre-existing array */ public final float[] getSerializedData() { serialize(); @@ -177,7 +177,7 @@ public abstract class CompactArray 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) { @@ -195,7 +195,7 @@ public abstract class CompactArray 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) { diff --git a/jme3-core/src/main/java/com/jme3/animation/EffectTrack.java b/jme3-core/src/main/java/com/jme3/animation/EffectTrack.java index a05b481c4..597237d24 100644 --- a/jme3-core/src/main/java/com/jme3/animation/EffectTrack.java +++ b/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 @@ -247,7 +247,7 @@ public class EffectTrack implements ClonableTrack { /** * Clone this track * - * @return + * @return a new instance */ @Override public Track clone() { diff --git a/jme3-core/src/main/java/com/jme3/animation/Skeleton.java b/jme3-core/src/main/java/com/jme3/animation/Skeleton.java index 651bf06a3..e29ffb3cc 100644 --- a/jme3-core/src/main/java/com/jme3/animation/Skeleton.java +++ b/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 @@ -203,7 +203,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; @@ -212,7 +212,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]; @@ -221,7 +221,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++) { @@ -235,7 +235,7 @@ public final class Skeleton implements Savable, JmeCloneable { /** * returns the bone index of the given bone * @param bone - * @return + * @return the index (≥0) or -1 if not found */ public int getBoneIndex(Bone bone) { for (int i = 0; i < boneList.length; i++) { @@ -250,7 +250,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 (≥0) or -1 if not found */ public int getBoneIndex(String name) { for (int i = 0; i < boneList.length; i++) { @@ -263,8 +263,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 - * @return + * Compute the skinning matrices for each bone of the skeleton that would be used to transform vertices of associated meshes + * @return the pre-existing matrices */ public Matrix4f[] computeSkinningMatrices() { TempVars vars = TempVars.get(); @@ -277,7 +277,7 @@ public final class Skeleton implements Savable, JmeCloneable { /** * returns the number of bones of this skeleton - * @return + * @return the count (≥0) */ public int getBoneCount() { return boneList.length; diff --git a/jme3-core/src/main/java/com/jme3/animation/SkeletonControl.java b/jme3-core/src/main/java/com/jme3/animation/SkeletonControl.java index 06f6927ab..2f54771db 100644 --- a/jme3-core/src/main/java/com/jme3/animation/SkeletonControl.java +++ b/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 @@ -405,7 +405,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; diff --git a/jme3-core/src/main/java/com/jme3/app/ChaseCameraAppState.java b/jme3-core/src/main/java/com/jme3/app/ChaseCameraAppState.java index 2aa8bebb6..1823e18ac 100644 --- a/jme3-core/src/main/java/com/jme3/app/ChaseCameraAppState.java +++ b/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; diff --git a/jme3-core/src/main/java/com/jme3/app/LegacyApplication.java b/jme3-core/src/main/java/com/jme3/app/LegacyApplication.java index d796ba309..1cc53b75e 100644 --- a/jme3-core/src/main/java/com/jme3/app/LegacyApplication.java +++ b/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. *

- * After calling this method, cast the {@link #getContext() context} to - * {@link JmeCanvasContext}, - * then acquire the canvas with {@link JmeCanvasContext#getCanvas() } + * After calling this method, cast the {@link #getContext()} context to + * JmeCanvasContext, + * 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(){ diff --git a/jme3-core/src/main/java/com/jme3/app/package.html b/jme3-core/src/main/java/com/jme3/app/package.html index ec6bb9a89..63d18c955 100644 --- a/jme3-core/src/main/java/com/jme3/app/package.html +++ b/jme3-core/src/main/java/com/jme3/app/package.html @@ -50,7 +50,6 @@ public class ExampleUse extends Application {
app.start();
}

- @Override
public void initialize(){
super.initialize();

@@ -58,7 +57,6 @@ public class ExampleUse extends Application {
viewPort.attachScene(rootNode);
}

- @Override
public void update(){
super.update();

diff --git a/jme3-core/src/main/java/com/jme3/audio/AudioNode.java b/jme3-core/src/main/java/com/jme3/audio/AudioNode.java index 862348b63..393d1ff1e 100644 --- a/jme3-core/src/main/java/com/jme3/audio/AudioNode.java +++ b/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. - *
+ *
* 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. diff --git a/jme3-core/src/main/java/com/jme3/audio/AudioRenderer.java b/jme3-core/src/main/java/com/jme3/audio/AudioRenderer.java index 695999e48..f10fd5d26 100644 --- a/jme3-core/src/main/java/com/jme3/audio/AudioRenderer.java +++ b/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); diff --git a/jme3-core/src/main/java/com/jme3/audio/AudioSource.java b/jme3-core/src/main/java/com/jme3/audio/AudioSource.java index 75a4e70f9..de2540022 100644 --- a/jme3-core/src/main/java/com/jme3/audio/AudioSource.java +++ b/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() } - * or {@link AudioSource#stop() } methods are called. + * The status will be changed when either the {@link AudioNode#play()} + * 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. - * - * @see AudioSource#setVelocity(com.jme3.math.Vector3f) + * @return The position of the audio source. */ 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(); diff --git a/jme3-core/src/main/java/com/jme3/audio/openal/ALAudioRenderer.java b/jme3-core/src/main/java/com/jme3/audio/openal/ALAudioRenderer.java index 82c588d4d..a4bcddeea 100644 --- a/jme3-core/src/main/java/com/jme3/audio/openal/ALAudioRenderer.java +++ b/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. } diff --git a/jme3-core/src/main/java/com/jme3/cinematic/Cinematic.java b/jme3-core/src/main/java/com/jme3/cinematic/Cinematic.java index 253ae735f..d9e9d5b11 100644 --- a/jme3-core/src/main/java/com/jme3/cinematic/Cinematic.java +++ b/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) { diff --git a/jme3-core/src/main/java/com/jme3/cinematic/MotionPath.java b/jme3-core/src/main/java/com/jme3/cinematic/MotionPath.java index 4e3a0df89..a0f978f0a 100644 --- a/jme3-core/src/main/java/com/jme3/cinematic/MotionPath.java +++ b/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 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 (≥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(); diff --git a/jme3-core/src/main/java/com/jme3/cinematic/events/AbstractCinematicEvent.java b/jme3-core/src/main/java/com/jme3/cinematic/events/AbstractCinematicEvent.java index 695eb9349..6fb4899c3 100644 --- a/jme3-core/src/main/java/com/jme3/cinematic/events/AbstractCinematicEvent.java +++ b/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; diff --git a/jme3-core/src/main/java/com/jme3/cinematic/events/MotionEvent.java b/jme3-core/src/main/java/com/jme3/cinematic/events/MotionEvent.java index 60cb5c09e..e7d217f45 100644 --- a/jme3-core/src/main/java/com/jme3/cinematic/events/MotionEvent.java +++ b/jme3-core/src/main/java/com/jme3/cinematic/events/MotionEvent.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 @@ -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 */ @Deprecated @Override @@ -321,7 +321,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; @@ -337,7 +337,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; @@ -353,7 +353,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; @@ -431,7 +431,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; @@ -470,7 +470,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; diff --git a/jme3-core/src/main/java/com/jme3/cinematic/events/SoundEvent.java b/jme3-core/src/main/java/com/jme3/cinematic/events/SoundEvent.java index 6de7e21f6..fe31678c3 100644 --- a/jme3-core/src/main/java/com/jme3/cinematic/events/SoundEvent.java +++ b/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; diff --git a/jme3-core/src/main/java/com/jme3/collision/CollisionResult.java b/jme3-core/src/main/java/com/jme3/collision/CollisionResult.java index ae271c880..d66ec62cf 100644 --- a/jme3-core/src/main/java/com/jme3/collision/CollisionResult.java +++ b/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 CollisionResult 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 */ diff --git a/jme3-core/src/main/java/com/jme3/collision/CollisionResults.java b/jme3-core/src/main/java/com/jme3/collision/CollisionResults.java index 087e143d7..93c5c81b5 100644 --- a/jme3-core/src/main/java/com/jme3/collision/CollisionResults.java +++ b/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 { /** * Internal use only. * @param index - * @return + * @return the pre-existing instance */ public CollisionResult getCollisionDirect(int index){ if (results == null) { diff --git a/jme3-core/src/main/java/com/jme3/effect/ParticleEmitter.java b/jme3-core/src/main/java/com/jme3/effect/ParticleEmitter.java index ba0c0282d..020803c87 100644 --- a/jme3-core/src/main/java/com/jme3/effect/ParticleEmitter.java +++ b/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. variation 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 diff --git a/jme3-core/src/main/java/com/jme3/effect/influencers/RadialParticleInfluencer.java b/jme3-core/src/main/java/com/jme3/effect/influencers/RadialParticleInfluencer.java index fba223dc1..567763c9f 100644 --- a/jme3-core/src/main/java/com/jme3/effect/influencers/RadialParticleInfluencer.java +++ b/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; diff --git a/jme3-core/src/main/java/com/jme3/environment/EnvironmentCamera.java b/jme3-core/src/main/java/com/jme3/environment/EnvironmentCamera.java index a8fa7de37..025d9a7b4 100644 --- a/jme3-core/src/main/java/com/jme3/environment/EnvironmentCamera.java +++ b/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 @@ -289,7 +289,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; @@ -311,7 +311,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); @@ -327,7 +327,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); @@ -341,7 +341,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 diff --git a/jme3-core/src/main/java/com/jme3/environment/LightProbeFactory.java b/jme3-core/src/main/java/com/jme3/environment/LightProbeFactory.java index 859472fe1..537c94cc8 100644 --- a/jme3-core/src/main/java/com/jme3/environment/LightProbeFactory.java +++ b/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 @@ -51,10 +51,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. @@ -78,7 +79,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)} * * * diff --git a/jme3-core/src/main/java/com/jme3/environment/generation/IrradianceSphericalHarmonicsGenerator.java b/jme3-core/src/main/java/com/jme3/environment/generation/IrradianceSphericalHarmonicsGenerator.java index 2e80ea3aa..7a3f637ff 100644 --- a/jme3-core/src/main/java/com/jme3/environment/generation/IrradianceSphericalHarmonicsGenerator.java +++ b/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) { diff --git a/jme3-core/src/main/java/com/jme3/environment/generation/PrefilteredEnvMapFaceGenerator.java b/jme3-core/src/main/java/com/jme3/environment/generation/PrefilteredEnvMapFaceGenerator.java index fbfa73669..cd4f96998 100644 --- a/jme3-core/src/main/java/com/jme3/environment/generation/PrefilteredEnvMapFaceGenerator.java +++ b/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 - * {@link EnvMapUtils.FixSeamsMethod} + * @param fixSeamsMethod the method used to fix seams as described in + * {@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 - * @return + * @param store caller-provided storage + * @return either store or a new vector (not null) */ public Vector3f importanceSampleGGX(Vector4f xi, float a2, Vector3f store) { if (store == null) { diff --git a/jme3-core/src/main/java/com/jme3/environment/generation/RunnableWithProgress.java b/jme3-core/src/main/java/com/jme3/environment/generation/RunnableWithProgress.java index 33fc922c6..dec5abd2a 100644 --- a/jme3-core/src/main/java/com/jme3/environment/generation/RunnableWithProgress.java +++ b/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; diff --git a/jme3-core/src/main/java/com/jme3/environment/util/EnvMapUtils.java b/jme3-core/src/main/java/com/jme3/environment/util/EnvMapUtils.java index 91b65655e..8f7ad841c 100644 --- a/jme3-core/src/main/java/com/jme3/environment/util/EnvMapUtils.java +++ b/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 - * r,g,b channnel + * @return an array of 9 vectors representing the coefficients for each + * 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 - * r,g,b channnel + * @return an array of 9 vectors representing the coefficients for each + * 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()); diff --git a/jme3-core/src/main/java/com/jme3/environment/util/LightsDebugState.java b/jme3-core/src/main/java/com/jme3/environment/util/LightsDebugState.java index 53565a753..31c51c971 100644 --- a/jme3-core/src/main/java/com/jme3/environment/util/LightsDebugState.java +++ b/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 @@ -157,7 +157,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; diff --git a/jme3-core/src/main/java/com/jme3/font/BitmapCharacterSet.java b/jme3-core/src/main/java/com/jme3/font/BitmapCharacterSet.java index 8760e0ec0..f1c6f644e 100644 --- a/jme3-core/src/main/java/com/jme3/font/BitmapCharacterSet.java +++ b/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) { diff --git a/jme3-core/src/main/java/com/jme3/font/BitmapFont.java b/jme3-core/src/main/java/com/jme3/font/BitmapFont.java index 856268c37..694278057 100644 --- a/jme3-core/src/main/java/com/jme3/font/BitmapFont.java +++ b/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); diff --git a/jme3-core/src/main/java/com/jme3/input/ChaseCamera.java b/jme3-core/src/main/java/com/jme3/input/ChaseCamera.java index c185393f2..43f0941fc 100644 --- a/jme3-core/src/main/java/com/jme3/input/ChaseCamera.java +++ b/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 @@ -268,7 +268,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 */ @Deprecated @Override @@ -707,7 +707,7 @@ public class ChaseCamera implements ActionListener, AnalogListener, Control, Jme /** * returns the chasing sensitivity - * @return + * @return the sensitivity */ public float getChasingSensitivity() { return chasingSensitivity; @@ -726,7 +726,7 @@ public class ChaseCamera implements ActionListener, AnalogListener, Control, Jme /** * Returns the rotation sensitivity - * @return + * @return the sensitivity */ public float getRotationSensitivity() { return rotationSensitivity; @@ -745,7 +745,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; @@ -763,7 +763,7 @@ public class ChaseCamera implements ActionListener, AnalogListener, Control, Jme /** * * returns the trailing rotation inertia - * @return + * @return the inertia */ public float getTrailingRotationInertia() { return trailingRotationInertia; @@ -781,7 +781,7 @@ public class ChaseCamera implements ActionListener, AnalogListener, Control, Jme /** * returns the trailing sensitivity - * @return + * @return the sensitivity */ public float getTrailingSensitivity() { return trailingSensitivity; @@ -799,7 +799,7 @@ public class ChaseCamera implements ActionListener, AnalogListener, Control, Jme /** * returns the zoom sensitivity - * @return + * @return the sensitivity */ public float getZoomSensitivity() { return zoomSensitivity; @@ -863,7 +863,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; @@ -904,7 +904,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; @@ -912,7 +912,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; @@ -920,7 +920,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; @@ -928,7 +928,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; @@ -952,7 +952,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; diff --git a/jme3-core/src/main/java/com/jme3/input/event/InputEvent.java b/jme3-core/src/main/java/com/jme3/input/event/InputEvent.java index 761abc1aa..e22c2a3d0 100644 --- a/jme3-core/src/main/java/com/jme3/input/event/InputEvent.java +++ b/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; diff --git a/jme3-core/src/main/java/com/jme3/input/event/JoyAxisEvent.java b/jme3-core/src/main/java/com/jme3/input/event/JoyAxisEvent.java index 5ba56c43b..724b7c1bb 100644 --- a/jme3-core/src/main/java/com/jme3/input/event/JoyAxisEvent.java +++ b/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(); diff --git a/jme3-core/src/main/java/com/jme3/input/event/JoyButtonEvent.java b/jme3-core/src/main/java/com/jme3/input/event/JoyButtonEvent.java index 4a2c701d7..f69e3f029 100644 --- a/jme3-core/src/main/java/com/jme3/input/event/JoyButtonEvent.java +++ b/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; diff --git a/jme3-core/src/main/java/com/jme3/light/LightProbe.java b/jme3-core/src/main/java/com/jme3/light/LightProbe.java index d6d716877..c2e011c6c 100644 --- a/jme3-core/src/main/java/com/jme3/light/LightProbe.java +++ b/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 @@ -54,7 +54,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 centered on its position. It can have a Spherical area or an Oriented Box area @@ -86,7 +87,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() { } diff --git a/jme3-core/src/main/java/com/jme3/material/Material.java b/jme3-core/src/main/java/com/jme3/material/Material.java index ddd75ace7..0f4528993 100644 --- a/jme3-core/src/main/java/com/jme3/material/Material.java +++ b/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 @@ -361,7 +361,7 @@ public class Material implements CloneableSmartAsset, Cloneable, Savable { *

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. @@ -942,7 +942,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})