diff --git a/externs/olx.js b/externs/olx.js index 2302efb277..e14d655832 100644 --- a/externs/olx.js +++ b/externs/olx.js @@ -3796,7 +3796,7 @@ olx.source.ServerVectorOptions.prototype.loader; /** - * Loading strategy. Default is `ol.loadingstrategy.bbox`. + * Loading strategy. Default is {@link ol.loadingstrategy.bbox}. * @type {function(ol.Extent, number): Array.|undefined} */ olx.source.ServerVectorOptions.prototype.strategy; diff --git a/src/ol/loadingstrategy.js b/src/ol/loadingstrategy.js index a6af39a671..0679ed5e7b 100644 --- a/src/ol/loadingstrategy.js +++ b/src/ol/loadingstrategy.js @@ -4,6 +4,7 @@ goog.require('ol.TileCoord'); /** + * Strategy function for loading all features with a single request. * @param {ol.Extent} extent Extent. * @param {number} resolution Resolution. * @return {Array.} Extents. @@ -15,6 +16,8 @@ ol.loadingstrategy.all = function(extent, resolution) { /** + * Strategy function for loading features based on the view's extent and + * resolution. * @param {ol.Extent} extent Extent. * @param {number} resolution Resolution. * @return {Array.} Extents. @@ -26,6 +29,7 @@ ol.loadingstrategy.bbox = function(extent, resolution) { /** + * Creates a strategy function for loading features based on a tile grid. * @param {ol.tilegrid.TileGrid} tileGrid Tile grid. * @return {function(ol.Extent, number): Array.} Loading strategy. * @todo api diff --git a/src/ol/loadingstrategy.jsdoc b/src/ol/loadingstrategy.jsdoc new file mode 100644 index 0000000000..baecef7850 --- /dev/null +++ b/src/ol/loadingstrategy.jsdoc @@ -0,0 +1,5 @@ +/** + * Strategies for loading vector data. + * @see ol.source.ServerVector + * @namespace ol.loadingstrategy + */