Skip to content

Commit fc64079

Browse files
committed
Merge pull request AdamAtomic#183 from IQAndreas/flxtween-asdoc
Finish adding ASDoc for FlxTween class
2 parents 4ded6c2 + 37bfccf commit fc64079

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

src/org/flixel/FlxTween.as

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ package org.flixel
1313
{
1414

1515
/**
16-
* A simple, linear tween (constant motion, with no acceleration).
16+
* Instantiate a new tween object.
1717
*
1818
* @param StartValue The starting value.
1919
* @param EndValue The end value.
@@ -55,12 +55,16 @@ package org.flixel
5555

5656

5757
/**
58-
* TODO: ASDoc
58+
* Current progress of the tween, between 0 and `duration` inclusive.
5959
*/
6060
public function get progress():Number
6161
{
6262
return _progress;
6363
}
64+
65+
/**
66+
* @private
67+
*/
6468
public function set progress(value:Number):void
6569
{
6670
if (value >= duration)
@@ -76,15 +80,15 @@ package org.flixel
7680
}
7781

7882
/**
79-
* TODO: ASDoc
83+
* Returns `true` if the tween has finished to completion.
8084
*/
8185
public function get finished():Boolean
8286
{
8387
return (_progress >= duration);
8488
}
8589

8690
/**
87-
* TODO: ASDoc
91+
* The calculated value based on the current `progress`.
8892
*/
8993
public function get value():Number
9094
{

0 commit comments

Comments
 (0)