jme3-networking/jme3-plugins JavaDoc corrections (comments only)

This commit is contained in:
Stephen Gold 2019-02-26 13:14:30 -08:00
parent 058d729e55
commit 1d7f7bae57
5 changed files with 12 additions and 13 deletions

View File

@ -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<T> {
}
/**
* 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();

View File

@ -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
* <p>Animation <code>name</code> is using to access animation via {@link AnimControl}.<br>
* <p>Animation <code>name</code> is using to access animation via {@link com.jme3.animation.AnimControl}.<br>
* <code>firstFrame</code> and <code>lastFrame</code> defines animation time interval.<br>
* Use <code>layerName</code> also to define source animation layer in the case of multiple layers in the scene.<br>
* Skeletal animations will be created if only scene contain skeletal bones</p>
@ -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) {

View File

@ -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();

View File

@ -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
@ -223,7 +223,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() {

View File

@ -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