Add ol.easing to api docs

externs/olx.js

@@ -535,7 +535,8 @@ olx.animation.BounceOptions.prototype.duration;
 
 
 /**
- * The easing function to use. Default is `ol.easing.upAndDown`
+ * The easing function to use. Can be an {@link ol.easing} or a custom function.
+ * Default is {@link ol.easing.upAndDown}.
  * @type {function(number):number|undefined}
  */
 olx.animation.BounceOptions.prototype.easing;
@@ -573,7 +574,8 @@ olx.animation.PanOptions.prototype.duration;
 
 
 /**
- * The easing function to use. Default is `ol.easing.inAndOut`
+ * The easing function to use. Can be an {@link ol.easing} or a custom function.
+ * Default is {@link ol.easing.inAndOut}.
  * @type {function(number):number|undefined}
  */
 olx.animation.PanOptions.prototype.easing;
@@ -621,7 +623,8 @@ olx.animation.RotateOptions.prototype.duration;
 
 
 /**
- * The easing function to use. Default is `ol.easing.inAndOut`
+ * The easing function to use. Can be an {@link ol.easing} or a custom function.
+ * Default is {@link ol.easing.inAndOut}.
  * @type {function(number):number|undefined}
  */
 olx.animation.RotateOptions.prototype.easing;
@@ -660,7 +663,8 @@ olx.animation.ZoomOptions.prototype.duration;
 
 
 /**
- * Easing function.
+ * The easing function to use. Can be an {@link ol.easing} or a custom function.
+ * Default is {@link ol.easing.inAndOut}.
  * @type {function(number):number|undefined}
  */
 olx.animation.ZoomOptions.prototype.easing;

src/ol/animation.jsdoc

@@ -1,5 +1,6 @@
 /**
- * The {ol.animation} static methods are designed to be used with the {@link ol.Map#beforeRender} method.  For example:
+ * The animation static methods are designed to be used with the
+ * {@link ol.Map#beforeRender} method.  For example:
  *
  *     var map = new ol.Map({ ... });
  *     var zoom = ol.animation.zoom({

src/ol/easing.js

@@ -4,6 +4,7 @@ goog.require('goog.fx.easing');
 
 
 /**
+ * @function
  * @param {number} t Input between 0 and 1.
  * @return {number} Output between 0 and 1.
  * @todo api
@@ -12,6 +13,7 @@ ol.easing.easeIn = goog.fx.easing.easeIn;
 
 
 /**
+ * @function
  * @param {number} t Input between 0 and 1.
  * @return {number} Output between 0 and 1.
  * @todo api
@@ -20,6 +22,7 @@ ol.easing.easeOut = goog.fx.easing.easeOut;
 
 
 /**
+ * @function
  * @param {number} t Input between 0 and 1.
  * @return {number} Output between 0 and 1.
  * @todo api

src/ol/easing.jsdoc

@@ -0,0 +1,4 @@
+/**
+ * Easing functions for {@link ol.animation}.
+ * @namespace ol.easing
+ */