From 0360e8bce872a0e88791f1c438c0c2a9a47e7bc5 Mon Sep 17 00:00:00 2001 From: Marc Jansen Date: Sat, 18 Apr 2015 08:26:26 +0200 Subject: [PATCH 1/7] Add unit 'us-ft' to API docs --- src/ol/proj/proj.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/ol/proj/proj.js b/src/ol/proj/proj.js index f69f02483c..6ec9c030f8 100644 --- a/src/ol/proj/proj.js +++ b/src/ol/proj/proj.js @@ -24,7 +24,7 @@ ol.proj.ProjectionLike; /** - * Projection units: `'degrees'`, `'ft'`, `'m'` or `'pixels'`. + * Projection units: `'degrees'`, `'ft'`, `'m'`, `'pixels'`, or `'us-ft'`. * @enum {string} * @api stable */ From 192639a8768adac76ccbee286e35aca88cbb3ae0 Mon Sep 17 00:00:00 2001 From: Marc Jansen Date: Sat, 18 Apr 2015 08:31:31 +0200 Subject: [PATCH 2/7] Add basic docs for layer.Heatmap --- src/ol/layer/heatmaplayer.js | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/ol/layer/heatmaplayer.js b/src/ol/layer/heatmaplayer.js index 28c46f690a..58f3ccae7e 100644 --- a/src/ol/layer/heatmaplayer.js +++ b/src/ol/layer/heatmaplayer.js @@ -191,6 +191,7 @@ ol.layer.Heatmap.prototype.createCircle_ = function() { /** + * Return the blur size in pixels. * @return {number} Blur size in pixels. * @api * @observable @@ -201,6 +202,7 @@ ol.layer.Heatmap.prototype.getBlur = function() { /** + * Return the gradient colors as array of strings. * @return {Array.} Colors. * @api * @observable @@ -212,6 +214,7 @@ ol.layer.Heatmap.prototype.getGradient = function() { /** + * Return the size of the radius in pixels. * @return {number} Radius size in pixel. * @api * @observable @@ -266,6 +269,7 @@ ol.layer.Heatmap.prototype.handleRender_ = function(event) { /** + * Set the blur size in pixels. * @param {number} blur Blur size in pixels. * @api * @observable @@ -276,6 +280,7 @@ ol.layer.Heatmap.prototype.setBlur = function(blur) { /** + * Set the gradient colors as array of strings. * @param {Array.} colors Gradient. * @api * @observable @@ -286,6 +291,7 @@ ol.layer.Heatmap.prototype.setGradient = function(colors) { /** + * Set the size of the radius in pixels. * @param {number} radius Radius size in pixel. * @api * @observable From 18bb32e4090064032713e8984929e260a7ee63ab Mon Sep 17 00:00:00 2001 From: Marc Jansen Date: Sat, 18 Apr 2015 08:41:53 +0200 Subject: [PATCH 3/7] Add basic docs for layer.Image --- src/ol/layer/imagelayer.js | 1 + 1 file changed, 1 insertion(+) diff --git a/src/ol/layer/imagelayer.js b/src/ol/layer/imagelayer.js index f4b3a23cee..36f96b4c13 100644 --- a/src/ol/layer/imagelayer.js +++ b/src/ol/layer/imagelayer.js @@ -26,6 +26,7 @@ goog.inherits(ol.layer.Image, ol.layer.Layer); /** + * Return the associated {@link ol.source.Image source} of the image layer. * @function * @return {ol.source.Image} Source. * @api stable From b46505a09b20b2a229e1908a4002cb376a52f069 Mon Sep 17 00:00:00 2001 From: Marc Jansen Date: Sat, 18 Apr 2015 08:58:20 +0200 Subject: [PATCH 4/7] Add basic docs for layer.Base --- src/ol/layer/layerbase.js | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/src/ol/layer/layerbase.js b/src/ol/layer/layerbase.js index 0a5aaa4438..dd964eeb42 100644 --- a/src/ol/layer/layerbase.js +++ b/src/ol/layer/layerbase.js @@ -87,6 +87,7 @@ goog.inherits(ol.layer.Base, ol.Object); /** + * Return the brightness of the layer. * @return {number} The brightness of the layer. * @observable * @api @@ -97,6 +98,7 @@ ol.layer.Base.prototype.getBrightness = function() { /** + * Return the contrast of the layer. * @return {number} The contrast of the layer. * @observable * @api @@ -107,6 +109,7 @@ ol.layer.Base.prototype.getContrast = function() { /** + * Return the hue of the layer. * @return {number} The hue of the layer. * @observable * @api @@ -163,6 +166,8 @@ ol.layer.Base.prototype.getLayerStatesArray = goog.abstractMethod; /** + * Return the {@link ol.Extent extent} of the layer or `undefined` if it + * will be visible regardless of extent. * @return {ol.Extent|undefined} The layer extent. * @observable * @api stable @@ -174,6 +179,7 @@ ol.layer.Base.prototype.getExtent = function() { /** + * Return the maximum resolution of the layer. * @return {number} The maximum resolution of the layer. * @observable * @api stable @@ -185,6 +191,7 @@ ol.layer.Base.prototype.getMaxResolution = function() { /** + * Return the minimum resolution of the layer. * @return {number} The minimum resolution of the layer. * @observable * @api stable @@ -196,6 +203,7 @@ ol.layer.Base.prototype.getMinResolution = function() { /** + * Return the opacity of the layer (between 0 and 1). * @return {number} The opacity of the layer. * @observable * @api stable @@ -206,6 +214,7 @@ ol.layer.Base.prototype.getOpacity = function() { /** + * Return the saturation of the layer. * @return {number} The saturation of the layer. * @observable * @api @@ -222,6 +231,7 @@ ol.layer.Base.prototype.getSourceState = goog.abstractMethod; /** + * Return the visibility of the layer (`true` or `false`). * @return {boolean} The visibility of the layer. * @observable * @api stable @@ -297,6 +307,7 @@ ol.layer.Base.prototype.setExtent = function(extent) { /** + * Set the maximum resolution at which the layer is visible. * @param {number} maxResolution The maximum resolution of the layer. * @observable * @api stable @@ -307,6 +318,7 @@ ol.layer.Base.prototype.setMaxResolution = function(maxResolution) { /** + * Set the minimum resolution at which the layer is visible. * @param {number} minResolution The minimum resolution of the layer. * @observable * @api stable @@ -317,6 +329,7 @@ ol.layer.Base.prototype.setMinResolution = function(minResolution) { /** + * Set the opacity of the layer, allowed values range from 0 to 1. * @param {number} opacity The opacity of the layer. * @observable * @api stable @@ -342,6 +355,7 @@ ol.layer.Base.prototype.setSaturation = function(saturation) { /** + * Set the visibility of the layer (`true` or `false`). * @param {boolean} visible The visibility of the layer. * @observable * @api stable From b457b267432ce4299bedefc680e38fd93cac11ad Mon Sep 17 00:00:00 2001 From: Marc Jansen Date: Sat, 18 Apr 2015 08:59:40 +0200 Subject: [PATCH 5/7] Add basic docs for layer.Group --- src/ol/layer/layergroup.js | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/src/ol/layer/layergroup.js b/src/ol/layer/layergroup.js index 626dce76f4..a69bfa5425 100644 --- a/src/ol/layer/layergroup.js +++ b/src/ol/layer/layergroup.js @@ -144,8 +144,10 @@ ol.layer.Group.prototype.handleLayersRemove_ = function(collectionEvent) { /** + * Returns the {@link ol.Collection collection} of {@link ol.layer.Layer layers} + * in this group. * @return {!ol.Collection.} Collection of - * {@link ol.layer.Layer layers} that are part of this group. + * {@link ol.layer.Layer layers} that are part of this group. * @observable * @api stable */ @@ -156,8 +158,10 @@ ol.layer.Group.prototype.getLayers = function() { /** + * Set the {@link ol.Collection collection} of {@link ol.layer.Layer layers} + * in this group. * @param {!ol.Collection.} layers Collection of - * {@link ol.layer.Layer layers} that are part of this group. + * {@link ol.layer.Layer layers} that are part of this group. * @observable * @api stable */ From 041abdb6a1374d899dc6d07621d3cac5173f5a3f Mon Sep 17 00:00:00 2001 From: Marc Jansen Date: Sat, 18 Apr 2015 08:59:55 +0200 Subject: [PATCH 6/7] Add basic docs for layer.Tile --- src/ol/layer/tilelayer.js | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/ol/layer/tilelayer.js b/src/ol/layer/tilelayer.js index baaf13f9f9..54c5262050 100644 --- a/src/ol/layer/tilelayer.js +++ b/src/ol/layer/tilelayer.js @@ -45,6 +45,7 @@ goog.inherits(ol.layer.Tile, ol.layer.Layer); /** + * Return the level as number to which we will preload tiles up to. * @return {number} The level to preload tiles up to. * @observable * @api @@ -55,6 +56,7 @@ ol.layer.Tile.prototype.getPreload = function() { /** + * Return the associated {@link ol.source.Tile tilesource} of the layer. * @function * @return {ol.source.Tile} Source. * @api stable @@ -63,6 +65,7 @@ ol.layer.Tile.prototype.getSource; /** + * Set the level as number to which we will preload tiles up to. * @param {number} preload The level to preload tiles up to. * @observable * @api @@ -73,6 +76,7 @@ ol.layer.Tile.prototype.setPreload = function(preload) { /** + * Whether we use interim tiles on error. * @return {boolean} Use interim tiles on error. * @observable * @api @@ -84,6 +88,7 @@ ol.layer.Tile.prototype.getUseInterimTilesOnError = function() { /** + * Set whether we use interim tiles on error. * @param {boolean} useInterimTilesOnError Use interim tiles on error. * @observable * @api From a278c65e61c166e543de6097be232c790c7b991d Mon Sep 17 00:00:00 2001 From: Marc Jansen Date: Sat, 18 Apr 2015 09:00:07 +0200 Subject: [PATCH 7/7] Add basic docs for layer.Vector --- src/ol/layer/vectorlayer.js | 1 + 1 file changed, 1 insertion(+) diff --git a/src/ol/layer/vectorlayer.js b/src/ol/layer/vectorlayer.js index a70da218ef..49e2b3fd9f 100644 --- a/src/ol/layer/vectorlayer.js +++ b/src/ol/layer/vectorlayer.js @@ -100,6 +100,7 @@ ol.layer.Vector.prototype.getRenderOrder = function() { /** + * Return the associated {@link ol.source.Vector vectorsource} of the layer. * @function * @return {ol.source.Vector} Source. * @api stable