AbstractCinematicEvent JavaDocs errors

[GoogleCodeExporter]

Wiki URL or package name of documentation: AbstractCinematicEvent 

Java docs for this package contain many spelling errors. 

Missing periods in class description.
=====================================
           this class A cinematic 
should be: this class. A cinematic 

Missing period at end of the description.
           (default is 10) 
Should be: (default is 10).

Misspellings and missing periods under Constructor Summary
==========================================================
AbstractCinematicEvent()
           contruct a cinematic event
Should be: Construct a cinematic event.

AbstractCinematicEvent(float initialDuration)
           contruct a cinematic event wwith the given initial duration
Should be: Construct a cinematic event with the given initial duration.

AbstractCinematicEvent(float initialDuration, LoopMode loopMode)
           contruct a cinematic event with the given loopMode and the given initialDuration
Should be: Construct a cinematic event with the given loopMode and the given 
initialDuration.

AbstractCinematicEvent(LoopMode loopMode)
           contruct a cinematic event with the given loopMode
Should be: Construct a cinematic event with the given loopMode.

Misspellings and missing periods under Method Summary
=====================================================
addListener(CinematicEventListener listener)
           Add a CinematicEventListener to this event
missing period: this event.

getDuration()
           returns the actual duration of the animtion (initialDuration/speed)
Should be: Returns the actual duration of the animation (initialDuration/speed).

getInitialDuration()
           returns
Should be: Returns

getLoopMode()
           retursthe loopMode of the animation
Should be: Returns the loopMode of the animation.

getPlayState() missing period.

getSpeed()
           returns
Should be: Returns

getTime()
           returns the current time of the cinematic event
Should be: Returns the current time of the cinematic event.

initEvent(Application app, Cinematic cinematic)
           initialize this event (should be called internally only)
Should be: Initialize this event (should be called internally only).

internalUpdate(float tpf)
           should be used internally only
Should be: Should be used internally only.

onPause()
           place here the code you want to execute when the event is paused
Should be: Place here the code you want to execute when the event is paused.

onPlay() missing period.

onUpdate(float tpf) missing period.

pause()
           pause this event
Should be: Pause this event.

play() missing period.

read(JmeImporter im)
           for serialization only
Should be: For serialization only.

removeListener(CinematicEventListener listener)
           remove a CinematicEventListener from this event
Should be: Remove a CinematicEventListener from this event.

setInitialDuration(float initialDuration)
           Sets the duration of the antionamtion at speed = 1 in seconds
should be: Sets the duration of the animation at speed = 1 in seconds.

setLoopMode(LoopMode loopMode) missing period.

setTime(float time)
           given time according tim 0 is the start of the event.
Should be?: given time. Time 0 is the start of the event.

stop()
           stops
Should be: Stops

write(JmeExporter ex)
           for serialization only
Should be: For serialization only.

Lastly, constructor and method details are missing parameter and return 
descriptions.

Original issue reported on code.google.com by mitm...@yahoo.com on 18 Nov 2012 at 6:04

[GoogleCodeExporter]

Thanks, it would be easier if you could supply these in patch form.

Original comment by normen667 on 18 Dec 2012 at 4:43

[GoogleCodeExporter]

I fixed the typos, thanks for the report!

PS: You can create a patch in the JME3 SDK by right-clicking the Java file 
under Projects, then click Subversion->Diff, and inside the Diff, you click 
"textual" (that's the patch).

Original comment by roo...@gmail.com on 23 Nov 2013 at 3:02

• Changed state: Done