Improve docs for getPointResolution functions

This commit is contained in:
Peter Robins
2017-06-08 17:00:00 +01:00
parent 9691130b83
commit f97f370e5b
3 changed files with 10 additions and 3 deletions

View File

@@ -680,7 +680,8 @@ olx.ProjectionOptions.prototype.worldExtent;
/**
* Function to determine resolution at a point. The function is called with a
* `{number}` view resolution and an `{ol.Coordinate}` as arguments, and returns
* the `{number}` resolution at the passed coordinate.
* the `{number}` resolution at the passed coordinate. If this is `undefined`,
* the default {@link ol.proj#getPointResolution} function will be used.
* @type {(function(number, ol.Coordinate):number|undefined)}
* @api
*/