Bug 1029370 part 3 - Add a comment explaining the relationship between ComputedTiming and GetComputedTimingAt; r=dholbert
authorBrian Birtles <birtles@gmail.com>
Wed, 25 Jun 2014 09:42:19 +0900
changeset 190608 26d6c067ee0de58aa64297a03804b9e6ce72154e
parent 190607 695c4dc0efc7f09fd1a7cd1ad8135cf918f0a176
child 190609 71f6b8a9b2e8cb698a495eb29d7611cb030073a9
push id1
push userroot
push dateMon, 20 Oct 2014 17:29:22 +0000
reviewersdholbert
bugs1029370
milestone33.0a1
Bug 1029370 part 3 - Add a comment explaining the relationship between ComputedTiming and GetComputedTimingAt; r=dholbert Review for this patch granted as part of bug 1029370 comment 4 (at the end).
layout/style/AnimationCommon.h
--- a/layout/style/AnimationCommon.h
+++ b/layout/style/AnimationCommon.h
@@ -258,16 +258,21 @@ struct AnimationTiming
     return mFillMode == NS_STYLE_ANIMATION_FILL_MODE_BOTH ||
            mFillMode == NS_STYLE_ANIMATION_FILL_MODE_BACKWARDS;
   }
 };
 
 /**
  * Stores the results of calculating the timing properties of an animation
  * at a given sample time.
+ *
+ * The members of a default-constructed object of this type are not meaningful.
+ * Rather, this object is intended to be used as the return value of
+ * ElementAnimation::GetComputedTimingAt which ensures all members are set
+ * correctly.
  */
 struct ComputedTiming
 {
   ComputedTiming()
   : mTimeFraction(kNullTimeFraction),
     mCurrentIteration(0)
   { }