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

Improve documentation for animation-related stuff

Browse Source 
The animation-related code is missing sufficient detail to make it
usable without digging in to the code.  This adds some additional
detail to the ol.animation namespace, the related options, and makes
note of the existance of ol.animation in the documentation of
ol.Map.addPreRenderFunction(s).
This commit is contained in:
Paul Spencer
2013-08-30 11:32:47 -04:00
parent 29317c3316
commit 8c4c83b207
3 changed files with 22 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
src/ol/map.js
View File

@@ -363,7 +363,8 @@ ol.Map.prototype.addLayer = function(layer) {
/**
* Add a prerender function. This can be used for attaching animations to
* be performed before setting the map's center.
* be performed before setting the map's center. The {@link ol.animation}
* namespace provides several static methods for creating prerender functions.
* @param {ol.PreRenderFunction} preRenderFunction Pre-render function.
*/
ol.Map.prototype.addPreRenderFunction = function(preRenderFunction) {
@@ -374,7 +375,7 @@ ol.Map.prototype.addPreRenderFunction = function(preRenderFunction) {
/**
* Add prerender functions. This can be used for attaching animations to
* be performed before setting the map's center.
* be performed before setting the map's center. See {@link ol.animation}
* @param {Array.<ol.PreRenderFunction>} preRenderFunctions
* Pre-render functions.
*/