Added comments

Signed-off-by: Niels van Hoorn <nvh@nvh.io>
koenbok · Sep 15, 2016 · 40b20be · 40b20be
1 parent 6c3e0ca
commit 40b20be
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/framer/Animation.coffee b/framer/Animation.coffee
@@ -36,6 +36,9 @@ evaluateRelativeProperty = (target, k, v) ->
 class exports.Animation extends BaseClass
 
 		_.defaults(options, parameters.options)
+	# 'properties' are the layer properties that will be animated
+	# 'options' are the animationOptions for this animation
+	# It's also possible to provide options through an 'options' key in the 'properties object'
 	constructor: (properties={}, options={}) ->
 
 		delete parameters.options

diff --git a/framer/Layer.coffee b/framer/Layer.coffee
@@ -885,6 +885,8 @@ class exports.Layer extends BaseClass
 	##############################################################
 	## ANIMATION
 
+	# Used to animate to a state with a specific name
+	# We lookup the stateName and call 'animate' with the properties of the state
 	animateToState: (stateName, options={}) ->
 		properties = @_stateMachine.switchTo stateName
 		if @_stateMachine.previousName is @_stateMachine.currentName