Better docs for #getPointResolution

2015-03-18 09:26:02 +01:00
parent 7916f36f7a
commit d8f624bf44
1 changed files with 8 additions and 6 deletions
@@ -470,10 +470,12 @@ olx.ProjectionOptions.prototype.global;
 olx.ProjectionOptions.prototype.worldExtent;

 /**
-* Function to determine resolution at a point.
-* @type {(function(number, ol.Coordinate):number|undefined)}
-* @api
-*/
+ * 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.
+ * @type {(function(number, ol.Coordinate):number|undefined)}
+ * @api
+ */
 olx.ProjectionOptions.prototype.getPointResolution;