diff --git a/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/BlenderContext.java b/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/BlenderContext.java index c96807ed0..fea54f13b 100644 --- a/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/BlenderContext.java +++ b/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/BlenderContext.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 @@ -304,10 +304,7 @@ public class BlenderContext { * * @param oldMemoryAddress * the address of the feature - * @param featureName - * the name of the feature - * @param structure - * the filled structure of the feature + * @param featureDataType * @param feature * the feature we want to store */ @@ -330,7 +327,7 @@ public class BlenderContext { * @param oldMemoryAddress * the address of the feature * @param loadedFeatureDataType - * the type of data we want to retreive it can be either filled + * the type of data we want to retrieve it can be either filled * structure or already converted feature * @return loaded feature or null if it was not yet loaded */ @@ -497,7 +494,7 @@ public class BlenderContext { } /** - * This method retreives the structure at the top of the parent's stack but + * This method retrieves the structure at the top of the parent's stack but * does not remove it. * * @return the structure from the top of the stack @@ -754,7 +751,7 @@ public class BlenderContext { } /** - * This enum defines what loaded data type user wants to retreive. It can be + * This enum defines what loaded data type user wants to retrieve. It can be * either filled structure or already converted data. * * @author Marcin Roguski (Kaelthas) diff --git a/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/constraints/Constraint.java b/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/constraints/Constraint.java index f2268199c..d96a1f2ce 100644 --- a/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/constraints/Constraint.java +++ b/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/constraints/Constraint.java @@ -48,8 +48,6 @@ public abstract class Constraint { * the constraint's structure (bConstraint clss in blender 2.49). * @param ownerOMA * the old memory address of the constraint owner - * @param ownerType - * the type of the constraint owner * @param influenceIpo * the ipo curve of the influence factor * @param blenderContext diff --git a/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/constraints/ConstraintHelper.java b/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/constraints/ConstraintHelper.java index 6d3058ed2..eb253396a 100644 --- a/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/constraints/ConstraintHelper.java +++ b/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/constraints/ConstraintHelper.java @@ -153,7 +153,7 @@ public class ConstraintHelper extends AbstractBlenderHelper { * the blender context * @return constraint object for the required type * @throws BlenderFileException - * thrown when problems with blender file occured + * thrown when problems with blender file occurred */ private Constraint createConstraint(String dataType, Structure constraintStructure, Long ownerOMA, Ipo influenceIpo, BlenderContext blenderContext) throws BlenderFileException { if (dataType == null || "Mesh".equalsIgnoreCase(dataType) || "Camera".equalsIgnoreCase(dataType) || "Lamp".equalsIgnoreCase(dataType)) { @@ -197,7 +197,7 @@ public class ConstraintHelper extends AbstractBlenderHelper { } /** - * The method retreives the transform from a feature in a given space. + * The method retrieves the transform from a feature in a given space. * * @param oma * the OMA of the feature (spatial or armature node) @@ -205,7 +205,7 @@ public class ConstraintHelper extends AbstractBlenderHelper { * the feature's subtarget (bone in a case of armature's node) * @param space * the space the transform is evaluated to - * @return thensform of a feature in a given space + * @return the transform of a feature in a given space */ public Transform getTransform(Long oma, String subtargetName, Space space) { Spatial feature = (Spatial) blenderContext.getLoadedFeature(oma, LoadedDataType.FEATURE); diff --git a/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/file/BlenderFileException.java b/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/file/BlenderFileException.java index 4c25a52da..9deeb8fa7 100644 --- a/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/file/BlenderFileException.java +++ b/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/file/BlenderFileException.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 @@ -49,7 +49,7 @@ public class BlenderFileException extends Exception { /** * Constructor. Creates an exception containing the given message. * @param message - * the message describing the problem that occured + * the message describing the problem that occurred */ public BlenderFileException(String message) { super(message); @@ -58,7 +58,7 @@ public class BlenderFileException extends Exception { /** * Constructor. Creates an exception that is based upon other thrown object. It contains the whole stacktrace then. * @param throwable - * an exception/error that occured + * an exception/error that occurred */ public BlenderFileException(Throwable throwable) { super(throwable); @@ -67,9 +67,9 @@ public class BlenderFileException extends Exception { /** * Constructor. Creates an exception with both a message and stacktrace. * @param message - * the message describing the problem that occured + * the message describing the problem that occurred * @param throwable - * an exception/error that occured + * an exception/error that occurred */ public BlenderFileException(String message, Throwable throwable) { super(message, throwable); diff --git a/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/math/Matrix.java b/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/math/Matrix.java index 29550f23b..0b05f2f1f 100644 --- a/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/math/Matrix.java +++ b/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/math/Matrix.java @@ -186,11 +186,8 @@ public class Matrix extends SimpleMatrix { } /** - * 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 - * vector where the scale will be stored */ public Vector3d toScaleVector() { Vector3d result = new Vector3d(); @@ -199,11 +196,10 @@ public class Matrix extends SimpleMatrix { } /** - * 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 - * vector where the scale will be stored + * @param vector the vector where the scale will be stored */ public void toScaleVector(Vector3d vector) { double scaleX = Math.sqrt(this.get(0, 0) * this.get(0, 0) + this.get(1, 0) * this.get(1, 0) + this.get(2, 0) * this.get(2, 0)); diff --git a/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/math/Vector3d.java b/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/math/Vector3d.java index db9b88304..92453cfa3 100644 --- a/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/math/Vector3d.java +++ b/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/math/Vector3d.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 @@ -116,8 +116,8 @@ public final class Vector3d implements Savable, Cloneable, Serializable { /** * Constructor instantiates a new Vector3d that is a copy * of the provided vector - * @param copy - * The Vector3d to copy + * @param vector3f + * The Vector3f to copy */ public Vector3d(Vector3f vector3f) { this(vector3f.x, vector3f.y, vector3f.z); diff --git a/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/meshes/MeshHelper.java b/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/meshes/MeshHelper.java index 4fcab8723..a9aa9cf78 100644 --- a/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/meshes/MeshHelper.java +++ b/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/meshes/MeshHelper.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 @@ -140,11 +140,11 @@ public class MeshHelper extends AbstractBlenderHelper { } /** - * This method returns the vertices. + * This method returns the vertices: a list of vertex positions and a list + * of vertex normals. * * @param meshStructure * the structure containing the mesh data - * @return a list of two - element arrays, the first element is the vertex and the second - its normal * @throws BlenderFileException * this exception is thrown when the blend file structure is somehow invalid or corrupted */ diff --git a/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/meshes/TemporalMesh.java b/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/meshes/TemporalMesh.java index 0416237bb..1b42b0c39 100644 --- a/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/meshes/TemporalMesh.java +++ b/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/meshes/TemporalMesh.java @@ -198,8 +198,7 @@ public class TemporalMesh extends Geometry { } /** - * @param the - * edge of the mesh + * @param edge the edge of the mesh * @return a list of faces that contain the given edge or an empty list */ public Collection getAdjacentFaces(Edge edge) { @@ -212,8 +211,7 @@ public class TemporalMesh extends Geometry { } /** - * @param the - * index of the mesh + * @param index the index of the mesh * @return a list of edges that contain the index */ public Collection getAdjacentEdges(Integer index) { @@ -223,8 +221,7 @@ public class TemporalMesh extends Geometry { /** * Tells if the given edge is a boundary edge. The boundary edge means that it belongs to a single * face or to none. - * @param the - * edge of the mesh + * @param edge the edge of the mesh * @return true if the edge is a boundary one and false otherwise */ public boolean isBoundary(Edge edge) { @@ -289,8 +286,9 @@ public class TemporalMesh extends Geometry { /** * The method rebuilds the mappings between faces and edges. Should be called after * every major change of the temporal mesh done outside it. - * @note I will remove this method soon and make the mappings to be done automatically - * when the mesh is modified. + *

+ * Note: I will remove this method soon and cause the mappings to be done + * automatically when the mesh is modified. */ public void rebuildIndexesMappings() { indexToEdgeMapping.clear(); diff --git a/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/textures/UserUVCollection.java b/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/textures/UserUVCollection.java index 083e5f50d..ea276af56 100644 --- a/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/textures/UserUVCollection.java +++ b/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/textures/UserUVCollection.java @@ -62,7 +62,7 @@ public class UserUVCollection { * the name of the UV set * @param vertexIndex * the vertex index corresponds to the index in jme mesh and not the original one in blender - * @return + * @return a pre-existing coordinate vector */ public Vector2f getUVForVertex(String uvSetName, int vertexIndex) { return uvsMap.get(uvSetName).get(vertexIndex);