Add documentation for API typedef functions

This commit is contained in:
Bart van den Eijnden
2014-02-13 13:23:04 +01:00
parent 20402a6e71
commit 87d651af04
6 changed files with 36 additions and 1 deletions

View File

@@ -7,8 +7,15 @@ goog.require('ol.TileCoord');
/**
* A function that takes an {@link ol.TileCoord} for the tile coordinate,
* a `{number}` representing the pixel ratio and an {@link ol.proj.Projection}
* for the projection as arguments and returns a `{string}` or
* undefined representing the tile URL. The this keyword inside the function
* references the {@link ol.source.TileImage}.
*
* @typedef {function(this: ol.source.TileImage, ol.TileCoord,
* number, ol.proj.Projection): (string|undefined)}
* @todo stability experimental
*/
ol.TileUrlFunctionType;