Skip to content

Commit 8a04afd

Browse files
stephengoldpspeed42
authored andcommitted
AnimControl: correct javadoc for the no-arg constructor (jMonkeyEngine#1233)
1 parent f9d2e03 commit 8a04afd

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

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

+10-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2009-2018 jMonkeyEngine
2+
* Copyright (c) 2009-2019 jMonkeyEngine
33
* All rights reserved.
44
*
55
* Redistribution and use in source and binary forms, with or without
@@ -102,7 +102,9 @@ public AnimControl(Skeleton skeleton) {
102102
}
103103

104104
/**
105-
* Serialization only. Do not use.
105+
* Instantiate an animation control with no skeleton, suitable only for
106+
* animations that don't contain any bone tracks. Also used for
107+
* serialization.
106108
*/
107109
public AnimControl() {
108110
}
@@ -144,6 +146,7 @@ public void setAnimations(HashMap<String, Animation> animations) {
144146

145147
/**
146148
* Retrieve an animation from the list of animations.
149+
*
147150
* @param name The name of the animation to retrieve.
148151
* @return The animation corresponding to the given name, or null, if no
149152
* such named animation exists.
@@ -155,6 +158,7 @@ public Animation getAnim(String name) {
155158
/**
156159
* Adds an animation to be available for playing to this
157160
* <code>AnimControl</code>.
161+
*
158162
* @param anim The animation to add.
159163
*/
160164
public void addAnim(Animation anim) {
@@ -163,6 +167,7 @@ public void addAnim(Animation anim) {
163167

164168
/**
165169
* Remove an animation so that it is no longer available for playing.
170+
*
166171
* @param anim The animation to remove.
167172
*/
168173
public void removeAnim(Animation anim) {
@@ -231,6 +236,7 @@ public Skeleton getSkeleton() {
231236

232237
/**
233238
* Adds a new listener to receive animation related events.
239+
*
234240
* @param listener The listener to add.
235241
*/
236242
public void addListener(AnimEventListener listener) {
@@ -244,6 +250,7 @@ public void addListener(AnimEventListener listener) {
244250

245251
/**
246252
* Removes the given listener from listening to events.
253+
*
247254
* @param listener
248255
* @see AnimControl#addListener(com.jme3.animation.AnimEventListener)
249256
*/
@@ -308,6 +315,7 @@ public Collection<String> getAnimationNames() {
308315

309316
/**
310317
* Returns the length of the given named animation.
318+
*
311319
* @param name The name of the animation
312320
* @return The length of time, in seconds, of the named animation.
313321
*/

0 commit comments

Comments
 (0)