[Pkg-javascript-commits] [jarisplayer] 14/80: better documentation for animation class

[Jonas Smedegaard]

This is an automated email from the git hooks/post-receive script.

js pushed a commit to branch master
in repository jarisplayer.

commit 3d38b8db375ab16b7c562d4f0f0abc6d8adb80e2
Author: jgmylm <jgmylm at edf201c3-a14d-0410-a11e-aa85364efa9f>
Date:   Thu Mar 11 15:45:15 2010 +0000

    better documentation for animation class
    
    git-svn-id: https://jaris.svn.sourceforge.net/svnroot/jaris/trunk@14 edf201c3-a14d-0410-a11e-aa85364efa9f
---
 src/jaris/animation/Animation.hx | 28 ++++++++++++++--------------
 src/jaris/display/Loader.hx      |  2 +-
 2 files changed, 15 insertions(+), 15 deletions(-)

diff --git a/src/jaris/animation/Animation.hx b/src/jaris/animation/Animation.hx
index 5edaa9d..91cf60b 100644
--- a/src/jaris/animation/Animation.hx
+++ b/src/jaris/animation/Animation.hx
@@ -30,10 +30,10 @@ class Animation
 
 	/**
 	 * Quick access to fade in effect
-	 * @param	object
-	 * @param	seconds
+	 * @param	object the object to animate
+	 * @param	seconds the duration of the animation
 	 */
-	public static function fadeIn(object:Dynamic, seconds:Float)
+	public static function fadeIn(object:Dynamic, seconds:Float):Void
 	{
 		var animation:AnimationsBase = new AnimationsBase();
 		animation.fadeIn(object, seconds);
@@ -41,10 +41,10 @@ class Animation
 	
 	/**
 	 * Quick access to fade out effect
-	 * @param	object
-	 * @param	seconds
+	 * @param	object the object to animate
+	 * @param	seconds the duration of the animation
 	 */
-	public static function fadeOut(object:Dynamic, seconds:Float)
+	public static function fadeOut(object:Dynamic, seconds:Float):Void
 	{
 		var animation:AnimationsBase = new AnimationsBase();
 		animation.fadeOut(object, seconds);
@@ -52,11 +52,11 @@ class Animation
 	
 	/**
 	 * Quick access to slide in effect
-	 * @param	object
-	 * @param	position
-	 * @param	seconds
+	 * @param	object the object to animate
+	 * @param	position could be top, left, bottom or right
+	 * @param	seconds the duration of the animation
 	 */
-	public static function slideIn(object:Dynamic, position:String, seconds:Float)
+	public static function slideIn(object:Dynamic, position:String, seconds:Float):Void
 	{
 		var animation:AnimationsBase = new AnimationsBase();
 		animation.slideIn(object, position, seconds);
@@ -64,11 +64,11 @@ class Animation
 	
 	/**
 	 * Quick access to slide out effect
-	 * @param	object
-	 * @param	position
-	 * @param	seconds
+	 * @param	object the object to animate
+	 * @param	position could be top, left, bottom or right
+	 * @param	seconds the duration of the animation
 	 */
-	public static function slideOut(object:Dynamic, position:String, seconds:Float)
+	public static function slideOut(object:Dynamic, position:String, seconds:Float):Void
 	{
 		var animation:AnimationsBase = new AnimationsBase();
 		animation.slideOut(object, position, seconds);
diff --git a/src/jaris/display/Loader.hx b/src/jaris/display/Loader.hx
index 4254538..3a309b4 100644
--- a/src/jaris/display/Loader.hx
+++ b/src/jaris/display/Loader.hx
@@ -29,7 +29,7 @@ import flash.events.Event;
 import flash.Lib;
 
 /**
- * Control to draw a loading bar
+ * Draws a loading bar
  */
 class Loader extends Sprite 
 {

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-javascript/jarisplayer.git