From 600cb3a0ff3ffec757f9510e198c5a0548913655 Mon Sep 17 00:00:00 2001
From: Tom Payne <twpayne@gmail.com>
Date: Wed, 4 Dec 2013 15:44:03 +0100
Subject: [PATCH] Add @struct annotation where possible

---
 src/ol/attribution.js                          | 1 +
 src/ol/kinetic.js                              | 1 +
 src/ol/proj/proj.js                            | 2 ++
 src/ol/render/canvas/canvasimmediate.js        | 1 +
 src/ol/render/canvas/canvasreplay.js           | 5 +++++
 src/ol/renderer/webgl/webglmapcolorshader.js   | 3 +++
 src/ol/renderer/webgl/webglmapdefaultshader.js | 3 +++
 src/ol/renderer/webgl/webgltilelayershader.js  | 3 +++
 src/ol/structs/buffer.js                       | 1 +
 src/ol/structs/integerset.js                   | 1 +
 src/ol/structs/lrucache.js                     | 1 +
 src/ol/structs/priorityqueue.js                | 1 +
 src/ol/structs/rbush.js                        | 2 ++
 src/ol/tilecache.js                            | 1 +
 src/ol/tilegrid/tilegrid.js                    | 1 +
 src/ol/tilegrid/wmtstilegrid.js                | 1 +
 src/ol/tilegrid/xyztilegrid.js                 | 1 +
 src/ol/tilequeue.js                            | 1 +
 src/ol/tilerange.js                            | 1 +
 src/ol/webgl/shader.js                         | 3 +++
 src/ol/webgl/shader.mustache                   | 3 +++
 21 files changed, 37 insertions(+)

diff --git a/src/ol/attribution.js b/src/ol/attribution.js
index 361572bcc7..b762dfb006 100644
--- a/src/ol/attribution.js
+++ b/src/ol/attribution.js
@@ -21,6 +21,7 @@ goog.require('ol.TileRange');
  *
  * @constructor
  * @param {ol.AttributionOptions} options Attribution options.
+ * @struct
  * @todo stability experimental
  */
 ol.Attribution = function(options) {
diff --git a/src/ol/kinetic.js b/src/ol/kinetic.js
index 7bdbf1a3d4..56833aed1b 100644
--- a/src/ol/kinetic.js
+++ b/src/ol/kinetic.js
@@ -13,6 +13,7 @@ goog.require('ol.animation');
  * @param {number} minVelocity Minimum velocity (pixels/millisecond).
  * @param {number} delay Delay to consider to calculate the kinetic
  *     initial values (milliseconds).
+ * @struct
  * @todo stability experimental
  */
 ol.Kinetic = function(decay, minVelocity, delay) {
diff --git a/src/ol/proj/proj.js b/src/ol/proj/proj.js
index c6268dd3ec..97b2d79b69 100644
--- a/src/ol/proj/proj.js
+++ b/src/ol/proj/proj.js
@@ -59,6 +59,7 @@ ol.METERS_PER_UNIT[ol.proj.Units.METERS] = 1;
 /**
  * @constructor
  * @param {ol.ProjectionOptions} options Projection options.
+ * @struct
  * @todo stability experimental
  */
 ol.proj.Projection = function(options) {
@@ -200,6 +201,7 @@ ol.proj.Projection.prototype.setDefaultTileGrid = function(tileGrid) {
  * @param {Proj4js.Proj} proj4jsProj Proj4js projection.
  * @param {ol.Proj4jsProjectionOptions} options Proj4js projection options.
  * @private
+ * @struct
  */
 ol.Proj4jsProjection_ = function(proj4jsProj, options) {
 
diff --git a/src/ol/render/canvas/canvasimmediate.js b/src/ol/render/canvas/canvasimmediate.js
index 746ed84e79..9b7782a0a1 100644
--- a/src/ol/render/canvas/canvasimmediate.js
+++ b/src/ol/render/canvas/canvasimmediate.js
@@ -19,6 +19,7 @@ goog.require('ol.style.Text');
  * @param {CanvasRenderingContext2D} context Context.
  * @param {ol.Extent} extent Extent.
  * @param {goog.vec.Mat4.AnyType} transform Transform.
+ * @struct
  */
 ol.render.canvas.Immediate = function(context, extent, transform) {
 
diff --git a/src/ol/render/canvas/canvasreplay.js b/src/ol/render/canvas/canvasreplay.js
index 375067ffec..d4c3f520e3 100644
--- a/src/ol/render/canvas/canvasreplay.js
+++ b/src/ol/render/canvas/canvasreplay.js
@@ -41,6 +41,7 @@ ol.render.canvas.Instruction = {
  * @constructor
  * @implements {ol.render.IRender}
  * @protected
+ * @struct
  */
 ol.render.canvas.Replay = function() {
 
@@ -346,6 +347,7 @@ ol.render.canvas.Replay.prototype.setTextStyle = goog.abstractMethod;
  * @constructor
  * @extends {ol.render.canvas.Replay}
  * @protected
+ * @struct
  */
 ol.render.canvas.ImageReplay = function() {
 
@@ -496,6 +498,7 @@ ol.render.canvas.ImageReplay.prototype.setImageStyle = function(imageStyle) {
  * @constructor
  * @extends {ol.render.canvas.Replay}
  * @protected
+ * @struct
  */
 ol.render.canvas.LineStringReplay = function() {
 
@@ -695,6 +698,7 @@ ol.render.canvas.LineStringReplay.prototype.setFillStrokeStyle =
  * @constructor
  * @extends {ol.render.canvas.Replay}
  * @protected
+ * @struct
  */
 ol.render.canvas.PolygonReplay = function() {
 
@@ -925,6 +929,7 @@ ol.render.canvas.PolygonReplay.prototype.setFillStrokeStyles_ = function() {
 /**
  * @constructor
  * @implements {ol.render.IReplayGroup}
+ * @struct
  */
 ol.render.canvas.ReplayGroup = function() {
 
diff --git a/src/ol/renderer/webgl/webglmapcolorshader.js b/src/ol/renderer/webgl/webglmapcolorshader.js
index 44bc6f212e..eeff8162d2 100644
--- a/src/ol/renderer/webgl/webglmapcolorshader.js
+++ b/src/ol/renderer/webgl/webglmapcolorshader.js
@@ -8,6 +8,7 @@ goog.require('ol.webgl.shader');
 /**
  * @constructor
  * @extends {ol.webgl.shader.Fragment}
+ * @struct
  */
 ol.renderer.webgl.map.shader.ColorFragment = function() {
   goog.base(this, ol.renderer.webgl.map.shader.ColorFragment.SOURCE);
@@ -43,6 +44,7 @@ ol.renderer.webgl.map.shader.ColorFragment.SOURCE = goog.DEBUG ?
 /**
  * @constructor
  * @extends {ol.webgl.shader.Vertex}
+ * @struct
  */
 ol.renderer.webgl.map.shader.ColorVertex = function() {
   goog.base(this, ol.renderer.webgl.map.shader.ColorVertex.SOURCE);
@@ -79,6 +81,7 @@ ol.renderer.webgl.map.shader.ColorVertex.SOURCE = goog.DEBUG ?
  * @constructor
  * @param {WebGLRenderingContext} gl GL.
  * @param {WebGLProgram} program Program.
+ * @struct
  */
 ol.renderer.webgl.map.shader.Color.Locations = function(gl, program) {
 
diff --git a/src/ol/renderer/webgl/webglmapdefaultshader.js b/src/ol/renderer/webgl/webglmapdefaultshader.js
index 8cf05e438f..47aff44a22 100644
--- a/src/ol/renderer/webgl/webglmapdefaultshader.js
+++ b/src/ol/renderer/webgl/webglmapdefaultshader.js
@@ -8,6 +8,7 @@ goog.require('ol.webgl.shader');
 /**
  * @constructor
  * @extends {ol.webgl.shader.Fragment}
+ * @struct
  */
 ol.renderer.webgl.map.shader.DefaultFragment = function() {
   goog.base(this, ol.renderer.webgl.map.shader.DefaultFragment.SOURCE);
@@ -43,6 +44,7 @@ ol.renderer.webgl.map.shader.DefaultFragment.SOURCE = goog.DEBUG ?
 /**
  * @constructor
  * @extends {ol.webgl.shader.Vertex}
+ * @struct
  */
 ol.renderer.webgl.map.shader.DefaultVertex = function() {
   goog.base(this, ol.renderer.webgl.map.shader.DefaultVertex.SOURCE);
@@ -79,6 +81,7 @@ ol.renderer.webgl.map.shader.DefaultVertex.SOURCE = goog.DEBUG ?
  * @constructor
  * @param {WebGLRenderingContext} gl GL.
  * @param {WebGLProgram} program Program.
+ * @struct
  */
 ol.renderer.webgl.map.shader.Default.Locations = function(gl, program) {
 
diff --git a/src/ol/renderer/webgl/webgltilelayershader.js b/src/ol/renderer/webgl/webgltilelayershader.js
index 8d8169042c..6cbb58103b 100644
--- a/src/ol/renderer/webgl/webgltilelayershader.js
+++ b/src/ol/renderer/webgl/webgltilelayershader.js
@@ -8,6 +8,7 @@ goog.require('ol.webgl.shader');
 /**
  * @constructor
  * @extends {ol.webgl.shader.Fragment}
+ * @struct
  */
 ol.renderer.webgl.tilelayer.shader.Fragment = function() {
   goog.base(this, ol.renderer.webgl.tilelayer.shader.Fragment.SOURCE);
@@ -43,6 +44,7 @@ ol.renderer.webgl.tilelayer.shader.Fragment.SOURCE = goog.DEBUG ?
 /**
  * @constructor
  * @extends {ol.webgl.shader.Vertex}
+ * @struct
  */
 ol.renderer.webgl.tilelayer.shader.Vertex = function() {
   goog.base(this, ol.renderer.webgl.tilelayer.shader.Vertex.SOURCE);
@@ -79,6 +81,7 @@ ol.renderer.webgl.tilelayer.shader.Vertex.SOURCE = goog.DEBUG ?
  * @constructor
  * @param {WebGLRenderingContext} gl GL.
  * @param {WebGLProgram} program Program.
+ * @struct
  */
 ol.renderer.webgl.tilelayer.shader.Locations = function(gl, program) {
 
diff --git a/src/ol/structs/buffer.js b/src/ol/structs/buffer.js
index 1a3aad615f..b18052ffe3 100644
--- a/src/ol/structs/buffer.js
+++ b/src/ol/structs/buffer.js
@@ -28,6 +28,7 @@ ol.BUFFER_REPLACE_UNUSED_ENTRIES_WITH_NANS = goog.DEBUG;
  * @param {Array.<number>=} opt_arr Array.
  * @param {number=} opt_used Used.
  * @param {number=} opt_usage Usage.
+ * @struct
  * @todo stability experimental
  */
 ol.structs.Buffer = function(opt_arr, opt_used, opt_usage) {
diff --git a/src/ol/structs/integerset.js b/src/ol/structs/integerset.js
index 17fc2ebc53..dc292443eb 100644
--- a/src/ol/structs/integerset.js
+++ b/src/ol/structs/integerset.js
@@ -9,6 +9,7 @@ goog.require('goog.asserts');
  * This implementation is designed for the case when the number of distinct
  * integer ranges is small.
  * @constructor
+ * @struct
  * @param {Array.<number>=} opt_arr Array.
  */
 ol.structs.IntegerSet = function(opt_arr) {
diff --git a/src/ol/structs/lrucache.js b/src/ol/structs/lrucache.js
index 12e8e5d49c..3fc7a2427d 100644
--- a/src/ol/structs/lrucache.js
+++ b/src/ol/structs/lrucache.js
@@ -10,6 +10,7 @@ goog.require('goog.object');
  * Object's properties (e.g. 'hasOwnProperty' is not allowed as a key). Expiring
  * items from the cache is the responsibility of the user.
  * @constructor
+ * @struct
  * @template T
  */
 ol.structs.LRUCache = function() {
diff --git a/src/ol/structs/priorityqueue.js b/src/ol/structs/priorityqueue.js
index b303d6c64c..72b4019475 100644
--- a/src/ol/structs/priorityqueue.js
+++ b/src/ol/structs/priorityqueue.js
@@ -17,6 +17,7 @@ goog.require('goog.object');
  * @constructor
  * @param {function(T): number} priorityFunction Priority function.
  * @param {function(T): string} keyFunction Key function.
+ * @struct
  * @template T
  */
 ol.structs.PriorityQueue = function(priorityFunction, keyFunction) {
diff --git a/src/ol/structs/rbush.js b/src/ol/structs/rbush.js
index e0bdc81819..85cefc282d 100644
--- a/src/ol/structs/rbush.js
+++ b/src/ol/structs/rbush.js
@@ -36,6 +36,7 @@ goog.require('ol.extent');
  * @param {number} height Height.
  * @param {Array.<ol.structs.RBushNode.<T>>} children Children.
  * @param {?T} value Value.
+ * @struct
  * @template T
  */
 ol.structs.RBushNode = function(extent, height, children, value) {
@@ -160,6 +161,7 @@ ol.structs.RBushNode.prototype.isLeaf = function() {
  * @constructor
  * @param {number=} opt_maxEntries Max entries.
  * @see https://github.com/mourner/rbush
+ * @struct
  * @template T
  */
 ol.structs.RBush = function(opt_maxEntries) {
diff --git a/src/ol/tilecache.js b/src/ol/tilecache.js
index baca04fb4a..643ed75ce9 100644
--- a/src/ol/tilecache.js
+++ b/src/ol/tilecache.js
@@ -18,6 +18,7 @@ ol.DEFAULT_TILE_CACHE_HIGH_WATER_MARK = 2048;
  * @constructor
  * @extends {ol.structs.LRUCache.<ol.Tile>}
  * @param {number=} opt_highWaterMark High water mark.
+ * @struct
  */
 ol.TileCache = function(opt_highWaterMark) {
 
diff --git a/src/ol/tilegrid/tilegrid.js b/src/ol/tilegrid/tilegrid.js
index e079159cd2..f39badb2fa 100644
--- a/src/ol/tilegrid/tilegrid.js
+++ b/src/ol/tilegrid/tilegrid.js
@@ -28,6 +28,7 @@ ol.DEFAULT_MAX_ZOOM = 42;
 /**
  * @constructor
  * @param {ol.tilegrid.TileGridOptions} options Tile grid options.
+ * @struct
  * @todo stability experimental
  */
 ol.tilegrid.TileGrid = function(options) {
diff --git a/src/ol/tilegrid/wmtstilegrid.js b/src/ol/tilegrid/wmtstilegrid.js
index 108840ecd4..d0bdcfffe9 100644
--- a/src/ol/tilegrid/wmtstilegrid.js
+++ b/src/ol/tilegrid/wmtstilegrid.js
@@ -11,6 +11,7 @@ goog.require('ol.tilegrid.TileGrid');
  * @constructor
  * @extends {ol.tilegrid.TileGrid}
  * @param {ol.tilegrid.WMTSOptions} options WMTS options.
+ * @struct
  * @todo stability experimental
  */
 ol.tilegrid.WMTS = function(options) {
diff --git a/src/ol/tilegrid/xyztilegrid.js b/src/ol/tilegrid/xyztilegrid.js
index aba7b4cc16..7aaedc09cd 100644
--- a/src/ol/tilegrid/xyztilegrid.js
+++ b/src/ol/tilegrid/xyztilegrid.js
@@ -13,6 +13,7 @@ goog.require('ol.tilegrid.TileGrid');
  * @constructor
  * @extends {ol.tilegrid.TileGrid}
  * @param {ol.tilegrid.XYZOptions} options XYZ options.
+ * @struct
  * @todo stability experimental
  */
 ol.tilegrid.XYZ = function(options) {
diff --git a/src/ol/tilequeue.js b/src/ol/tilequeue.js
index 57d0791caa..e0426a5cb4 100644
--- a/src/ol/tilequeue.js
+++ b/src/ol/tilequeue.js
@@ -22,6 +22,7 @@ ol.TilePriorityFunction;
  *     Tile priority function.
  * @param {function(): ?} tileChangeCallback
  *     Function called on each tile change event.
+ * @struct
  */
 ol.TileQueue = function(tilePriorityFunction, tileChangeCallback) {
 
diff --git a/src/ol/tilerange.js b/src/ol/tilerange.js
index 4ac7b36f3c..f2ef5d3245 100644
--- a/src/ol/tilerange.js
+++ b/src/ol/tilerange.js
@@ -15,6 +15,7 @@ goog.require('ol.TileCoord');
  * @param {number} maxX Maximum X.
  * @param {number} minY Minimum Y.
  * @param {number} maxY Maximum Y.
+ * @struct
  */
 ol.TileRange = function(minX, maxX, minY, maxY) {
 
diff --git a/src/ol/webgl/shader.js b/src/ol/webgl/shader.js
index a06fd5c401..f9a2271724 100644
--- a/src/ol/webgl/shader.js
+++ b/src/ol/webgl/shader.js
@@ -9,6 +9,7 @@ goog.require('ol.webgl');
 /**
  * @constructor
  * @param {string} source Source.
+ * @struct
  */
 ol.webgl.Shader = function(source) {
 
@@ -46,6 +47,7 @@ ol.webgl.Shader.prototype.isAnimated = goog.functions.FALSE;
  * @constructor
  * @extends {ol.webgl.Shader}
  * @param {string} source Source.
+ * @struct
  */
 ol.webgl.shader.Fragment = function(source) {
   goog.base(this, source);
@@ -66,6 +68,7 @@ ol.webgl.shader.Fragment.prototype.getType = function() {
  * @constructor
  * @extends {ol.webgl.Shader}
  * @param {string} source Source.
+ * @struct
  */
 ol.webgl.shader.Vertex = function(source) {
   goog.base(this, source);
diff --git a/src/ol/webgl/shader.mustache b/src/ol/webgl/shader.mustache
index 14ecdd6947..ed62dc9718 100644
--- a/src/ol/webgl/shader.mustache
+++ b/src/ol/webgl/shader.mustache
@@ -8,6 +8,7 @@ goog.require('ol.webgl.shader');
 /**
  * @constructor
  * @extends {ol.webgl.shader.Fragment}
+ * @struct
  */
 {{className}}Fragment = function() {
   goog.base(this, {{className}}Fragment.SOURCE);
@@ -43,6 +44,7 @@ goog.addSingletonGetter({{className}}Fragment);
 /**
  * @constructor
  * @extends {ol.webgl.shader.Vertex}
+ * @struct
  */
 {{className}}Vertex = function() {
   goog.base(this, {{className}}Vertex.SOURCE);
@@ -79,6 +81,7 @@ goog.addSingletonGetter({{className}}Vertex);
  * @constructor
  * @param {WebGLRenderingContext} gl GL.
  * @param {WebGLProgram} program Program.
+ * @struct
  */
 {{namespace}}.Locations = function(gl, program) {
 {{#getUniforms}}