From 0bfd22b2355f341e41296371e74cb4055751dbe6 Mon Sep 17 00:00:00 2001 From: Tim Schaub Date: Sun, 6 Sep 2015 07:54:38 -0600 Subject: [PATCH 01/10] Missing ol.Feature#getId description --- src/ol/feature.js | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/ol/feature.js b/src/ol/feature.js index 528e87ccdb..3c02fe862e 100644 --- a/src/ol/feature.js +++ b/src/ol/feature.js @@ -149,6 +149,9 @@ ol.Feature.prototype.getGeometry = function() { /** + * Get the feature identifier. This is a stable identifier for the feature and + * is either set when reading data from a remote source or set explicitly by + * calling {@link ol.Feature#setId}. * @return {number|string|undefined} Id. * @api stable * @observable From 9f5d8d3901fda4f63f9fa7282b23cb230e3d5325 Mon Sep 17 00:00:00 2001 From: Tim Schaub Date: Sun, 6 Sep 2015 07:56:15 -0600 Subject: [PATCH 02/10] Missing ol.ImageTile#getImage description --- src/ol/imagetile.js | 1 + 1 file changed, 1 insertion(+) diff --git a/src/ol/imagetile.js b/src/ol/imagetile.js index 52d7b4aee1..4750d17970 100644 --- a/src/ol/imagetile.js +++ b/src/ol/imagetile.js @@ -76,6 +76,7 @@ ol.ImageTile.prototype.disposeInternal = function() { /** + * Get the image element for this tile. * @inheritDoc * @api */ From 91f47a876c415c54ee9ab7106267469fa54cadb2 Mon Sep 17 00:00:00 2001 From: Tim Schaub Date: Sun, 6 Sep 2015 07:57:41 -0600 Subject: [PATCH 03/10] Missing ol.Observable#getRevision description --- src/ol/observable.js | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/ol/observable.js b/src/ol/observable.js index 3bc9020410..d5e409e550 100644 --- a/src/ol/observable.js +++ b/src/ol/observable.js @@ -62,6 +62,8 @@ ol.Observable.prototype.changed = function() { /** + * Get the version number for this object. Each time the object is modified, + * its version number will be incremented. * @return {number} Revision. * @api */ From 1a240ccf9dea907fa6650f3f3ac59b21dd1e5b8c Mon Sep 17 00:00:00 2001 From: Tim Schaub Date: Sun, 6 Sep 2015 08:35:38 -0600 Subject: [PATCH 04/10] Missing image style method descriptions --- src/ol/style/imagestyle.js | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/ol/style/imagestyle.js b/src/ol/style/imagestyle.js index aa71da5586..415aaeb868 100644 --- a/src/ol/style/imagestyle.js +++ b/src/ol/style/imagestyle.js @@ -119,6 +119,8 @@ ol.style.Image.prototype.getSnapToPixel = function() { /** + * Get the anchor point. The anchor determines the center point for the + * symbolizer. Its units are determined by `anchorXUnits` and `anchorYUnits`. * @function * @return {Array.} Anchor. */ @@ -126,6 +128,7 @@ ol.style.Image.prototype.getAnchor = goog.abstractMethod; /** + * Get the image element for the symbolizer. * @function * @param {number} pixelRatio Pixel ratio. * @return {HTMLCanvasElement|HTMLVideoElement|Image} Image element. @@ -159,6 +162,7 @@ ol.style.Image.prototype.getHitDetectionImageSize = goog.abstractMethod; /** + * Get the origin of the symbolizer. * @function * @return {Array.} Origin. */ @@ -166,6 +170,7 @@ ol.style.Image.prototype.getOrigin = goog.abstractMethod; /** + * Get the size of the symbolizer (in pixels). * @function * @return {ol.Size} Size. */ From d036602cec98a2b9e984773119725ea053fed5aa Mon Sep 17 00:00:00 2001 From: Tim Schaub Date: Sun, 6 Sep 2015 08:37:39 -0600 Subject: [PATCH 05/10] Missing ol.source.WMTS.optionsFromCapabilities description --- src/ol/source/wmtssource.js | 1 + 1 file changed, 1 insertion(+) diff --git a/src/ol/source/wmtssource.js b/src/ol/source/wmtssource.js index d4943717ad..08ddff7e4c 100644 --- a/src/ol/source/wmtssource.js +++ b/src/ol/source/wmtssource.js @@ -313,6 +313,7 @@ ol.source.WMTS.prototype.updateDimensions = function(dimensions) { /** + * Generate source options from a capabilities object. * @param {Object} wmtsCap An object representing the capabilities document. * @param {Object} config Configuration properties for the layer. Defaults for * the layer will apply if not provided. From fce931afbe9cd0b36cdd122faf60b1d17798683d Mon Sep 17 00:00:00 2001 From: Tim Schaub Date: Sun, 6 Sep 2015 08:39:50 -0600 Subject: [PATCH 06/10] Missing ol.render.Event#frameState description --- src/ol/render/renderevent.js | 1 + 1 file changed, 1 insertion(+) diff --git a/src/ol/render/renderevent.js b/src/ol/render/renderevent.js index 6d8810ae7e..9a0e647c2c 100644 --- a/src/ol/render/renderevent.js +++ b/src/ol/render/renderevent.js @@ -53,6 +53,7 @@ ol.render.Event = function( this.vectorContext = opt_vectorContext; /** + * An object representing the current render frame state. * @type {olx.FrameState|undefined} * @api */ From fe153b94fb6d1df7426abd740b3d900102654f4e Mon Sep 17 00:00:00 2001 From: Tim Schaub Date: Sun, 6 Sep 2015 09:31:51 -0600 Subject: [PATCH 07/10] Missing drag and drop event description --- src/ol/interaction/draganddropinteraction.js | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/ol/interaction/draganddropinteraction.js b/src/ol/interaction/draganddropinteraction.js index 4496ef4414..2297e2316d 100644 --- a/src/ol/interaction/draganddropinteraction.js +++ b/src/ol/interaction/draganddropinteraction.js @@ -219,18 +219,21 @@ ol.interaction.DragAndDropEvent = goog.base(this, type, target); /** + * The features parsed from dropped data. * @type {Array.|undefined} * @api stable */ this.features = opt_features; /** + * The dropped file. * @type {File} * @api stable */ this.file = file; /** + * The feature projection. * @type {ol.proj.Projection|undefined} * @api */ From eed926fa944432c70cb0247b6ba7d8c058e60f5c Mon Sep 17 00:00:00 2001 From: Tim Schaub Date: Sun, 6 Sep 2015 09:36:00 -0600 Subject: [PATCH 08/10] Missing ol.control.OverviewMap#getCollapsed description --- src/ol/control/overviewmapcontrol.js | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/ol/control/overviewmapcontrol.js b/src/ol/control/overviewmapcontrol.js index 124d0a8224..15a0624579 100644 --- a/src/ol/control/overviewmapcontrol.js +++ b/src/ol/control/overviewmapcontrol.js @@ -515,7 +515,8 @@ ol.control.OverviewMap.prototype.setCollapsed = function(collapsed) { /** - * @return {boolean} True if the widget is collapsed. + * Determine if the overview map is collapsed. + * @return {boolean} The overview map is collapsed. * @api stable */ ol.control.OverviewMap.prototype.getCollapsed = function() { From a09c07a42768a82c50c20f0dbb61a42f22c8a442 Mon Sep 17 00:00:00 2001 From: Tim Schaub Date: Sun, 6 Sep 2015 09:41:56 -0600 Subject: [PATCH 09/10] Missing vector context description --- src/ol/render/vectorcontext.js | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/ol/render/vectorcontext.js b/src/ol/render/vectorcontext.js index 80edf8425d..5345a592a0 100644 --- a/src/ol/render/vectorcontext.js +++ b/src/ol/render/vectorcontext.js @@ -3,6 +3,8 @@ goog.provide('ol.render.VectorContext'); /** + * Context for drawing geometries. A vector context is available on render + * events and does not need to be constructed directly. * @constructor * @struct * @api From 8311f090de4b72a121e1ef4c3caa703c2affceb0 Mon Sep 17 00:00:00 2001 From: Tim Schaub Date: Sun, 6 Sep 2015 09:46:33 -0600 Subject: [PATCH 10/10] Missing ol.render.webgl.Immediate#drawAsync description --- src/ol/render/webgl/webglimmediate.js | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/ol/render/webgl/webglimmediate.js b/src/ol/render/webgl/webglimmediate.js index 2a54aedcff..8e7fb7ad81 100644 --- a/src/ol/render/webgl/webglimmediate.js +++ b/src/ol/render/webgl/webglimmediate.js @@ -93,6 +93,9 @@ ol.render.webgl.Immediate.prototype.flush = function() { /** + * Register a function to be called for rendering at a given zIndex. The + * function will be called asynchronously. The callback will receive a + * reference to {@link ol.render.canvas.Immediate} context for drawing. * @param {number} zIndex Z index. * @param {function(ol.render.webgl.Immediate)} callback Callback. * @api