Add @struct annotation where possible

This commit is contained in:
Tom Payne
2013-12-04 15:44:03 +01:00
parent aa0a02b935
commit 600cb3a0ff
21 changed files with 37 additions and 0 deletions

View File

@@ -21,6 +21,7 @@ goog.require('ol.TileRange');
* *
* @constructor * @constructor
* @param {ol.AttributionOptions} options Attribution options. * @param {ol.AttributionOptions} options Attribution options.
* @struct
* @todo stability experimental * @todo stability experimental
*/ */
ol.Attribution = function(options) { ol.Attribution = function(options) {

View File

@@ -13,6 +13,7 @@ goog.require('ol.animation');
* @param {number} minVelocity Minimum velocity (pixels/millisecond). * @param {number} minVelocity Minimum velocity (pixels/millisecond).
* @param {number} delay Delay to consider to calculate the kinetic * @param {number} delay Delay to consider to calculate the kinetic
* initial values (milliseconds). * initial values (milliseconds).
* @struct
* @todo stability experimental * @todo stability experimental
*/ */
ol.Kinetic = function(decay, minVelocity, delay) { ol.Kinetic = function(decay, minVelocity, delay) {

View File

@@ -59,6 +59,7 @@ ol.METERS_PER_UNIT[ol.proj.Units.METERS] = 1;
/** /**
* @constructor * @constructor
* @param {ol.ProjectionOptions} options Projection options. * @param {ol.ProjectionOptions} options Projection options.
* @struct
* @todo stability experimental * @todo stability experimental
*/ */
ol.proj.Projection = function(options) { ol.proj.Projection = function(options) {
@@ -200,6 +201,7 @@ ol.proj.Projection.prototype.setDefaultTileGrid = function(tileGrid) {
* @param {Proj4js.Proj} proj4jsProj Proj4js projection. * @param {Proj4js.Proj} proj4jsProj Proj4js projection.
* @param {ol.Proj4jsProjectionOptions} options Proj4js projection options. * @param {ol.Proj4jsProjectionOptions} options Proj4js projection options.
* @private * @private
* @struct
*/ */
ol.Proj4jsProjection_ = function(proj4jsProj, options) { ol.Proj4jsProjection_ = function(proj4jsProj, options) {

View File

@@ -19,6 +19,7 @@ goog.require('ol.style.Text');
* @param {CanvasRenderingContext2D} context Context. * @param {CanvasRenderingContext2D} context Context.
* @param {ol.Extent} extent Extent. * @param {ol.Extent} extent Extent.
* @param {goog.vec.Mat4.AnyType} transform Transform. * @param {goog.vec.Mat4.AnyType} transform Transform.
* @struct
*/ */
ol.render.canvas.Immediate = function(context, extent, transform) { ol.render.canvas.Immediate = function(context, extent, transform) {

View File

@@ -41,6 +41,7 @@ ol.render.canvas.Instruction = {
* @constructor * @constructor
* @implements {ol.render.IRender} * @implements {ol.render.IRender}
* @protected * @protected
* @struct
*/ */
ol.render.canvas.Replay = function() { ol.render.canvas.Replay = function() {
@@ -346,6 +347,7 @@ ol.render.canvas.Replay.prototype.setTextStyle = goog.abstractMethod;
* @constructor * @constructor
* @extends {ol.render.canvas.Replay} * @extends {ol.render.canvas.Replay}
* @protected * @protected
* @struct
*/ */
ol.render.canvas.ImageReplay = function() { ol.render.canvas.ImageReplay = function() {
@@ -496,6 +498,7 @@ ol.render.canvas.ImageReplay.prototype.setImageStyle = function(imageStyle) {
* @constructor * @constructor
* @extends {ol.render.canvas.Replay} * @extends {ol.render.canvas.Replay}
* @protected * @protected
* @struct
*/ */
ol.render.canvas.LineStringReplay = function() { ol.render.canvas.LineStringReplay = function() {
@@ -695,6 +698,7 @@ ol.render.canvas.LineStringReplay.prototype.setFillStrokeStyle =
* @constructor * @constructor
* @extends {ol.render.canvas.Replay} * @extends {ol.render.canvas.Replay}
* @protected * @protected
* @struct
*/ */
ol.render.canvas.PolygonReplay = function() { ol.render.canvas.PolygonReplay = function() {
@@ -925,6 +929,7 @@ ol.render.canvas.PolygonReplay.prototype.setFillStrokeStyles_ = function() {
/** /**
* @constructor * @constructor
* @implements {ol.render.IReplayGroup} * @implements {ol.render.IReplayGroup}
* @struct
*/ */
ol.render.canvas.ReplayGroup = function() { ol.render.canvas.ReplayGroup = function() {

View File

@@ -8,6 +8,7 @@ goog.require('ol.webgl.shader');
/** /**
* @constructor * @constructor
* @extends {ol.webgl.shader.Fragment} * @extends {ol.webgl.shader.Fragment}
* @struct
*/ */
ol.renderer.webgl.map.shader.ColorFragment = function() { ol.renderer.webgl.map.shader.ColorFragment = function() {
goog.base(this, ol.renderer.webgl.map.shader.ColorFragment.SOURCE); goog.base(this, ol.renderer.webgl.map.shader.ColorFragment.SOURCE);
@@ -43,6 +44,7 @@ ol.renderer.webgl.map.shader.ColorFragment.SOURCE = goog.DEBUG ?
/** /**
* @constructor * @constructor
* @extends {ol.webgl.shader.Vertex} * @extends {ol.webgl.shader.Vertex}
* @struct
*/ */
ol.renderer.webgl.map.shader.ColorVertex = function() { ol.renderer.webgl.map.shader.ColorVertex = function() {
goog.base(this, ol.renderer.webgl.map.shader.ColorVertex.SOURCE); goog.base(this, ol.renderer.webgl.map.shader.ColorVertex.SOURCE);
@@ -79,6 +81,7 @@ ol.renderer.webgl.map.shader.ColorVertex.SOURCE = goog.DEBUG ?
* @constructor * @constructor
* @param {WebGLRenderingContext} gl GL. * @param {WebGLRenderingContext} gl GL.
* @param {WebGLProgram} program Program. * @param {WebGLProgram} program Program.
* @struct
*/ */
ol.renderer.webgl.map.shader.Color.Locations = function(gl, program) { ol.renderer.webgl.map.shader.Color.Locations = function(gl, program) {

View File

@@ -8,6 +8,7 @@ goog.require('ol.webgl.shader');
/** /**
* @constructor * @constructor
* @extends {ol.webgl.shader.Fragment} * @extends {ol.webgl.shader.Fragment}
* @struct
*/ */
ol.renderer.webgl.map.shader.DefaultFragment = function() { ol.renderer.webgl.map.shader.DefaultFragment = function() {
goog.base(this, ol.renderer.webgl.map.shader.DefaultFragment.SOURCE); goog.base(this, ol.renderer.webgl.map.shader.DefaultFragment.SOURCE);
@@ -43,6 +44,7 @@ ol.renderer.webgl.map.shader.DefaultFragment.SOURCE = goog.DEBUG ?
/** /**
* @constructor * @constructor
* @extends {ol.webgl.shader.Vertex} * @extends {ol.webgl.shader.Vertex}
* @struct
*/ */
ol.renderer.webgl.map.shader.DefaultVertex = function() { ol.renderer.webgl.map.shader.DefaultVertex = function() {
goog.base(this, ol.renderer.webgl.map.shader.DefaultVertex.SOURCE); goog.base(this, ol.renderer.webgl.map.shader.DefaultVertex.SOURCE);
@@ -79,6 +81,7 @@ ol.renderer.webgl.map.shader.DefaultVertex.SOURCE = goog.DEBUG ?
* @constructor * @constructor
* @param {WebGLRenderingContext} gl GL. * @param {WebGLRenderingContext} gl GL.
* @param {WebGLProgram} program Program. * @param {WebGLProgram} program Program.
* @struct
*/ */
ol.renderer.webgl.map.shader.Default.Locations = function(gl, program) { ol.renderer.webgl.map.shader.Default.Locations = function(gl, program) {

View File

@@ -8,6 +8,7 @@ goog.require('ol.webgl.shader');
/** /**
* @constructor * @constructor
* @extends {ol.webgl.shader.Fragment} * @extends {ol.webgl.shader.Fragment}
* @struct
*/ */
ol.renderer.webgl.tilelayer.shader.Fragment = function() { ol.renderer.webgl.tilelayer.shader.Fragment = function() {
goog.base(this, ol.renderer.webgl.tilelayer.shader.Fragment.SOURCE); goog.base(this, ol.renderer.webgl.tilelayer.shader.Fragment.SOURCE);
@@ -43,6 +44,7 @@ ol.renderer.webgl.tilelayer.shader.Fragment.SOURCE = goog.DEBUG ?
/** /**
* @constructor * @constructor
* @extends {ol.webgl.shader.Vertex} * @extends {ol.webgl.shader.Vertex}
* @struct
*/ */
ol.renderer.webgl.tilelayer.shader.Vertex = function() { ol.renderer.webgl.tilelayer.shader.Vertex = function() {
goog.base(this, ol.renderer.webgl.tilelayer.shader.Vertex.SOURCE); goog.base(this, ol.renderer.webgl.tilelayer.shader.Vertex.SOURCE);
@@ -79,6 +81,7 @@ ol.renderer.webgl.tilelayer.shader.Vertex.SOURCE = goog.DEBUG ?
* @constructor * @constructor
* @param {WebGLRenderingContext} gl GL. * @param {WebGLRenderingContext} gl GL.
* @param {WebGLProgram} program Program. * @param {WebGLProgram} program Program.
* @struct
*/ */
ol.renderer.webgl.tilelayer.shader.Locations = function(gl, program) { ol.renderer.webgl.tilelayer.shader.Locations = function(gl, program) {

View File

@@ -28,6 +28,7 @@ ol.BUFFER_REPLACE_UNUSED_ENTRIES_WITH_NANS = goog.DEBUG;
* @param {Array.<number>=} opt_arr Array. * @param {Array.<number>=} opt_arr Array.
* @param {number=} opt_used Used. * @param {number=} opt_used Used.
* @param {number=} opt_usage Usage. * @param {number=} opt_usage Usage.
* @struct
* @todo stability experimental * @todo stability experimental
*/ */
ol.structs.Buffer = function(opt_arr, opt_used, opt_usage) { ol.structs.Buffer = function(opt_arr, opt_used, opt_usage) {

View File

@@ -9,6 +9,7 @@ goog.require('goog.asserts');
* This implementation is designed for the case when the number of distinct * This implementation is designed for the case when the number of distinct
* integer ranges is small. * integer ranges is small.
* @constructor * @constructor
* @struct
* @param {Array.<number>=} opt_arr Array. * @param {Array.<number>=} opt_arr Array.
*/ */
ol.structs.IntegerSet = function(opt_arr) { ol.structs.IntegerSet = function(opt_arr) {

View File

@@ -10,6 +10,7 @@ goog.require('goog.object');
* Object's properties (e.g. 'hasOwnProperty' is not allowed as a key). Expiring * Object's properties (e.g. 'hasOwnProperty' is not allowed as a key). Expiring
* items from the cache is the responsibility of the user. * items from the cache is the responsibility of the user.
* @constructor * @constructor
* @struct
* @template T * @template T
*/ */
ol.structs.LRUCache = function() { ol.structs.LRUCache = function() {

View File

@@ -17,6 +17,7 @@ goog.require('goog.object');
* @constructor * @constructor
* @param {function(T): number} priorityFunction Priority function. * @param {function(T): number} priorityFunction Priority function.
* @param {function(T): string} keyFunction Key function. * @param {function(T): string} keyFunction Key function.
* @struct
* @template T * @template T
*/ */
ol.structs.PriorityQueue = function(priorityFunction, keyFunction) { ol.structs.PriorityQueue = function(priorityFunction, keyFunction) {

View File

@@ -36,6 +36,7 @@ goog.require('ol.extent');
* @param {number} height Height. * @param {number} height Height.
* @param {Array.<ol.structs.RBushNode.<T>>} children Children. * @param {Array.<ol.structs.RBushNode.<T>>} children Children.
* @param {?T} value Value. * @param {?T} value Value.
* @struct
* @template T * @template T
*/ */
ol.structs.RBushNode = function(extent, height, children, value) { ol.structs.RBushNode = function(extent, height, children, value) {
@@ -160,6 +161,7 @@ ol.structs.RBushNode.prototype.isLeaf = function() {
* @constructor * @constructor
* @param {number=} opt_maxEntries Max entries. * @param {number=} opt_maxEntries Max entries.
* @see https://github.com/mourner/rbush * @see https://github.com/mourner/rbush
* @struct
* @template T * @template T
*/ */
ol.structs.RBush = function(opt_maxEntries) { ol.structs.RBush = function(opt_maxEntries) {

View File

@@ -18,6 +18,7 @@ ol.DEFAULT_TILE_CACHE_HIGH_WATER_MARK = 2048;
* @constructor * @constructor
* @extends {ol.structs.LRUCache.<ol.Tile>} * @extends {ol.structs.LRUCache.<ol.Tile>}
* @param {number=} opt_highWaterMark High water mark. * @param {number=} opt_highWaterMark High water mark.
* @struct
*/ */
ol.TileCache = function(opt_highWaterMark) { ol.TileCache = function(opt_highWaterMark) {

View File

@@ -28,6 +28,7 @@ ol.DEFAULT_MAX_ZOOM = 42;
/** /**
* @constructor * @constructor
* @param {ol.tilegrid.TileGridOptions} options Tile grid options. * @param {ol.tilegrid.TileGridOptions} options Tile grid options.
* @struct
* @todo stability experimental * @todo stability experimental
*/ */
ol.tilegrid.TileGrid = function(options) { ol.tilegrid.TileGrid = function(options) {

View File

@@ -11,6 +11,7 @@ goog.require('ol.tilegrid.TileGrid');
* @constructor * @constructor
* @extends {ol.tilegrid.TileGrid} * @extends {ol.tilegrid.TileGrid}
* @param {ol.tilegrid.WMTSOptions} options WMTS options. * @param {ol.tilegrid.WMTSOptions} options WMTS options.
* @struct
* @todo stability experimental * @todo stability experimental
*/ */
ol.tilegrid.WMTS = function(options) { ol.tilegrid.WMTS = function(options) {

View File

@@ -13,6 +13,7 @@ goog.require('ol.tilegrid.TileGrid');
* @constructor * @constructor
* @extends {ol.tilegrid.TileGrid} * @extends {ol.tilegrid.TileGrid}
* @param {ol.tilegrid.XYZOptions} options XYZ options. * @param {ol.tilegrid.XYZOptions} options XYZ options.
* @struct
* @todo stability experimental * @todo stability experimental
*/ */
ol.tilegrid.XYZ = function(options) { ol.tilegrid.XYZ = function(options) {

View File

@@ -22,6 +22,7 @@ ol.TilePriorityFunction;
* Tile priority function. * Tile priority function.
* @param {function(): ?} tileChangeCallback * @param {function(): ?} tileChangeCallback
* Function called on each tile change event. * Function called on each tile change event.
* @struct
*/ */
ol.TileQueue = function(tilePriorityFunction, tileChangeCallback) { ol.TileQueue = function(tilePriorityFunction, tileChangeCallback) {

View File

@@ -15,6 +15,7 @@ goog.require('ol.TileCoord');
* @param {number} maxX Maximum X. * @param {number} maxX Maximum X.
* @param {number} minY Minimum Y. * @param {number} minY Minimum Y.
* @param {number} maxY Maximum Y. * @param {number} maxY Maximum Y.
* @struct
*/ */
ol.TileRange = function(minX, maxX, minY, maxY) { ol.TileRange = function(minX, maxX, minY, maxY) {

View File

@@ -9,6 +9,7 @@ goog.require('ol.webgl');
/** /**
* @constructor * @constructor
* @param {string} source Source. * @param {string} source Source.
* @struct
*/ */
ol.webgl.Shader = function(source) { ol.webgl.Shader = function(source) {
@@ -46,6 +47,7 @@ ol.webgl.Shader.prototype.isAnimated = goog.functions.FALSE;
* @constructor * @constructor
* @extends {ol.webgl.Shader} * @extends {ol.webgl.Shader}
* @param {string} source Source. * @param {string} source Source.
* @struct
*/ */
ol.webgl.shader.Fragment = function(source) { ol.webgl.shader.Fragment = function(source) {
goog.base(this, source); goog.base(this, source);
@@ -66,6 +68,7 @@ ol.webgl.shader.Fragment.prototype.getType = function() {
* @constructor * @constructor
* @extends {ol.webgl.Shader} * @extends {ol.webgl.Shader}
* @param {string} source Source. * @param {string} source Source.
* @struct
*/ */
ol.webgl.shader.Vertex = function(source) { ol.webgl.shader.Vertex = function(source) {
goog.base(this, source); goog.base(this, source);

View File

@@ -8,6 +8,7 @@ goog.require('ol.webgl.shader');
/** /**
* @constructor * @constructor
* @extends {ol.webgl.shader.Fragment} * @extends {ol.webgl.shader.Fragment}
* @struct
*/ */
{{className}}Fragment = function() { {{className}}Fragment = function() {
goog.base(this, {{className}}Fragment.SOURCE); goog.base(this, {{className}}Fragment.SOURCE);
@@ -43,6 +44,7 @@ goog.addSingletonGetter({{className}}Fragment);
/** /**
* @constructor * @constructor
* @extends {ol.webgl.shader.Vertex} * @extends {ol.webgl.shader.Vertex}
* @struct
*/ */
{{className}}Vertex = function() { {{className}}Vertex = function() {
goog.base(this, {{className}}Vertex.SOURCE); goog.base(this, {{className}}Vertex.SOURCE);
@@ -79,6 +81,7 @@ goog.addSingletonGetter({{className}}Vertex);
* @constructor * @constructor
* @param {WebGLRenderingContext} gl GL. * @param {WebGLRenderingContext} gl GL.
* @param {WebGLProgram} program Program. * @param {WebGLProgram} program Program.
* @struct
*/ */
{{namespace}}.Locations = function(gl, program) { {{namespace}}.Locations = function(gl, program) {
{{#getUniforms}} {{#getUniforms}}