From c7c203853c5b271fa2e71078a2dd3ce558bb17dc Mon Sep 17 00:00:00 2001 From: Stephen Gold Date: Tue, 26 Feb 2019 13:14:30 -0800 Subject: [PATCH] jme3-networking/jme3-plugins JavaDoc corrections (comments only) --- .../java/com/jme3/network/service/ServiceManager.java | 6 +++--- .../java/com/jme3/scene/plugins/fbx/AnimationList.java | 9 ++++----- .../com/jme3/scene/plugins/gltf/MaterialAdapter.java | 2 +- .../java/com/jme3/scene/plugins/ogre/SkeletonLoader.java | 4 ++-- .../scene/plugins/ogre/matext/MaterialExtension.java | 4 ++-- 5 files changed, 12 insertions(+), 13 deletions(-) diff --git a/jme3-networking/src/main/java/com/jme3/network/service/ServiceManager.java b/jme3-networking/src/main/java/com/jme3/network/service/ServiceManager.java index afcfd73c2..b337ce6b7 100644 --- a/jme3-networking/src/main/java/com/jme3/network/service/ServiceManager.java +++ b/jme3-networking/src/main/java/com/jme3/network/service/ServiceManager.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2015 jMonkeyEngine + * Copyright (c) 2015-2019 jMonkeyEngine * All rights reserved. * * Redistribution and use in source and binary forms, with or without @@ -55,9 +55,9 @@ public abstract class ServiceManager { } /** - * Retreives the 'parent' of this service manager, usually + * Retrieves the 'parent' of this service manager, usually * a more specifically typed version of 'this' but it can be - * anything the seervices are expecting. + * anything the services are expecting. */ protected abstract T getParent(); diff --git a/jme3-plugins/src/fbx/java/com/jme3/scene/plugins/fbx/AnimationList.java b/jme3-plugins/src/fbx/java/com/jme3/scene/plugins/fbx/AnimationList.java index 6ca884b8c..20f5c0fe8 100644 --- a/jme3-plugins/src/fbx/java/com/jme3/scene/plugins/fbx/AnimationList.java +++ b/jme3-plugins/src/fbx/java/com/jme3/scene/plugins/fbx/AnimationList.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2009-2014 jMonkeyEngine + * Copyright (c) 2009-2019 jMonkeyEngine * All rights reserved. * * Redistribution and use in source and binary forms, with or without @@ -36,7 +36,7 @@ import java.util.List; /** * Defines animations set that will be created while loading FBX scene - *

Animation name is using to access animation via {@link AnimControl}.
+ *

Animation name is using to access animation via {@link com.jme3.animation.AnimControl}.
* firstFrame and lastFrame defines animation time interval.
* Use layerName also to define source animation layer in the case of multiple layers in the scene.
* Skeletal animations will be created if only scene contain skeletal bones

@@ -47,8 +47,7 @@ public class AnimationList { /** * Use in the case of multiple animation layers in FBX asset - * @param name - animation name to assess via {@link AnimControl} - * @param layerName - source layer + * @param name - animation name to access via {@link com.jme3.animation.AnimControl} */ public void add(String name, int firstFrame, int lastFrame) { add(name, null, firstFrame, lastFrame); @@ -56,7 +55,7 @@ public class AnimationList { /** * Use in the case of multiple animation layers in FBX asset - * @param name - animation name to assess via {@link AnimControl} + * @param name - animation name to access via {@link com.jme3.animation.AnimControl} * @param layerName - source layer */ public void add(String name, String layerName, int firstFrame, int lastFrame) { diff --git a/jme3-plugins/src/gltf/java/com/jme3/scene/plugins/gltf/MaterialAdapter.java b/jme3-plugins/src/gltf/java/com/jme3/scene/plugins/gltf/MaterialAdapter.java index 602ad961f..759360e6a 100644 --- a/jme3-plugins/src/gltf/java/com/jme3/scene/plugins/gltf/MaterialAdapter.java +++ b/jme3-plugins/src/gltf/java/com/jme3/scene/plugins/gltf/MaterialAdapter.java @@ -26,7 +26,7 @@ public abstract class MaterialAdapter { /** * Should return the material definition used by this material adapter * - * @return + * @return path to the material definition */ protected abstract String getMaterialDefPath(); diff --git a/jme3-plugins/src/ogre/java/com/jme3/scene/plugins/ogre/SkeletonLoader.java b/jme3-plugins/src/ogre/java/com/jme3/scene/plugins/ogre/SkeletonLoader.java index d9977d3a9..59be5cf7d 100644 --- a/jme3-plugins/src/ogre/java/com/jme3/scene/plugins/ogre/SkeletonLoader.java +++ b/jme3-plugins/src/ogre/java/com/jme3/scene/plugins/ogre/SkeletonLoader.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 @@ -224,7 +224,7 @@ public class SkeletonLoader extends DefaultHandler implements AssetLoader { } /** - * Reset the SkeletonLoader in case an error occured while parsing XML. + * Reset the SkeletonLoader in case an error occurred while parsing XML. * This allows future use of the loader even after an error. */ private void fullReset() { diff --git a/jme3-plugins/src/ogre/java/com/jme3/scene/plugins/ogre/matext/MaterialExtension.java b/jme3-plugins/src/ogre/java/com/jme3/scene/plugins/ogre/matext/MaterialExtension.java index 192cbd909..5c68f5a78 100644 --- a/jme3-plugins/src/ogre/java/com/jme3/scene/plugins/ogre/matext/MaterialExtension.java +++ b/jme3-plugins/src/ogre/java/com/jme3/scene/plugins/ogre/matext/MaterialExtension.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 @@ -74,7 +74,7 @@ public class MaterialExtension { } /** - * Retreives a mapping from an Ogre3D base material texture alias + * Retrieves a mapping from an Ogre3D base material texture alias * to a jME3 texture param * @param ogreTexAlias The texture alias in the Ogre3D base material * @return The texture alias in the Ogre3D base material