ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Add ol.easing to api docs

Browse Source
This commit is contained in:
Peter Robins
2014-06-02 12:53:56 -04:00
committed by Frederic Junod
parent 33948a7244
commit 85c1427111
4 changed files with 17 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
externs/olx.js
View File

@@ -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} * @type {function(number):number|undefined}
*/ */
olx.animation.BounceOptions.prototype.easing; 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} * @type {function(number):number|undefined}
*/ */
olx.animation.PanOptions.prototype.easing; 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} * @type {function(number):number|undefined}
*/ */
olx.animation.RotateOptions.prototype.easing; 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} * @type {function(number):number|undefined}
*/ */
olx.animation.ZoomOptions.prototype.easing; olx.animation.ZoomOptions.prototype.easing;

3
src/ol/animation.jsdoc
View File

@@ -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 map = new ol.Map({ ... });
* var zoom = ol.animation.zoom({ * var zoom = ol.animation.zoom({

3
src/ol/easing.js
View File

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

4
src/ol/easing.jsdoc Normal file
View File

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