Do not document object literals as interfaces

Instead, object literals with properties that should not be
renamed can go in externs/olx.js.
This commit is contained in:
Andreas Hocevar
2014-05-15 12:10:32 +02:00
parent e050c905e2
commit eb6a938062
21 changed files with 108 additions and 167 deletions

View File

@@ -33,7 +33,7 @@ goog.inherits(ol.renderer.canvas.Layer, ol.renderer.Layer);
/**
* @param {oli.FrameState} frameState Frame state.
* @param {olx.FrameState} frameState Frame state.
* @param {ol.layer.LayerState} layerState Layer state.
* @param {CanvasRenderingContext2D} context Context.
*/
@@ -77,7 +77,7 @@ ol.renderer.canvas.Layer.prototype.composeFrame =
/**
* @param {ol.render.EventType} type Event type.
* @param {CanvasRenderingContext2D} context Context.
* @param {oli.FrameState} frameState Frame state.
* @param {olx.FrameState} frameState Frame state.
* @param {goog.vec.Mat4.Number=} opt_transform Transform.
* @private
*/
@@ -100,7 +100,7 @@ ol.renderer.canvas.Layer.prototype.dispatchComposeEvent_ =
/**
* @param {CanvasRenderingContext2D} context Context.
* @param {oli.FrameState} frameState Frame state.
* @param {olx.FrameState} frameState Frame state.
* @param {goog.vec.Mat4.Number=} opt_transform Transform.
* @protected
*/
@@ -113,7 +113,7 @@ ol.renderer.canvas.Layer.prototype.dispatchPostComposeEvent =
/**
* @param {CanvasRenderingContext2D} context Context.
* @param {oli.FrameState} frameState Frame state.
* @param {olx.FrameState} frameState Frame state.
* @param {goog.vec.Mat4.Number=} opt_transform Transform.
* @protected
*/
@@ -126,7 +126,7 @@ ol.renderer.canvas.Layer.prototype.dispatchPreComposeEvent =
/**
* @param {CanvasRenderingContext2D} context Context.
* @param {oli.FrameState} frameState Frame state.
* @param {olx.FrameState} frameState Frame state.
* @param {goog.vec.Mat4.Number=} opt_transform Transform.
* @protected
*/
@@ -150,7 +150,7 @@ ol.renderer.canvas.Layer.prototype.getImageTransform = goog.abstractMethod;
/**
* @param {oli.FrameState} frameState Frame state.
* @param {olx.FrameState} frameState Frame state.
* @protected
* @return {!goog.vec.Mat4.Number} Transform.
*/

View File

@@ -87,7 +87,7 @@ ol.renderer.canvas.Map.prototype.createLayerRenderer = function(layer) {
/**
* @param {ol.render.EventType} type Event type.
* @param {oli.FrameState} frameState Frame state.
* @param {olx.FrameState} frameState Frame state.
* @private
*/
ol.renderer.canvas.Map.prototype.dispatchComposeEvent_ =

View File

@@ -45,7 +45,7 @@ goog.inherits(ol.renderer.Layer, goog.Disposable);
/**
* @param {ol.Coordinate} coordinate Coordinate.
* @param {oli.FrameState} frameState Frame state.
* @param {olx.FrameState} frameState Frame state.
* @param {function(this: S, ol.Feature, ol.layer.Layer): T} callback Feature
* callback.
* @param {S} thisArg Value to use as `this` when executing `callback`.
@@ -96,7 +96,7 @@ ol.renderer.Layer.prototype.handleImageChange = function(event) {
/**
* @param {oli.FrameState} frameState Frame state.
* @param {olx.FrameState} frameState Frame state.
* @param {ol.layer.LayerState} layerState Layer state.
*/
ol.renderer.Layer.prototype.prepareFrame = goog.abstractMethod;
@@ -114,7 +114,7 @@ ol.renderer.Layer.prototype.renderIfReadyAndVisible = function() {
/**
* @param {oli.FrameState} frameState Frame state.
* @param {olx.FrameState} frameState Frame state.
* @param {ol.source.Tile} tileSource Tile source.
* @protected
*/
@@ -126,7 +126,7 @@ ol.renderer.Layer.prototype.scheduleExpireCache =
/**
* @param {ol.source.Tile} tileSource Tile source.
* @param {ol.Map} map Map.
* @param {oli.FrameState} frameState Frame state.
* @param {olx.FrameState} frameState Frame state.
*/
function(tileSource, map, frameState) {
var tileSourceKey = goog.getUid(tileSource).toString();
@@ -155,7 +155,7 @@ ol.renderer.Layer.prototype.updateAttributions =
/**
* @param {oli.FrameState} frameState Frame state.
* @param {olx.FrameState} frameState Frame state.
* @param {ol.source.Source} source Source.
* @protected
*/
@@ -241,7 +241,7 @@ ol.renderer.Layer.prototype.snapCenterToPixel =
* - registers idle tiles in frameState.wantedTiles so that they are not
* discarded by the tile queue
* - enqueues missing tiles
* @param {oli.FrameState} frameState Frame state.
* @param {olx.FrameState} frameState Frame state.
* @param {ol.source.Tile} tileSource Tile source.
* @param {ol.tilegrid.TileGrid} tileGrid Tile grid.
* @param {number} pixelRatio Pixel ratio.

View File

@@ -41,7 +41,7 @@ goog.inherits(ol.renderer.Map, goog.Disposable);
/**
* @param {oli.FrameState} frameState FrameState.
* @param {olx.FrameState} frameState FrameState.
* @protected
*/
ol.renderer.Map.prototype.calculateMatrices2D = function(frameState) {
@@ -82,7 +82,7 @@ ol.renderer.Map.prototype.disposeInternal = function() {
/**
* @param {ol.Coordinate} coordinate Coordinate.
* @param {oli.FrameState} frameState FrameState.
* @param {olx.FrameState} frameState FrameState.
* @param {function(this: S, ol.Feature, ol.layer.Layer): T} callback Feature
* callback.
* @param {S} thisArg Value to use as `this` when executing `callback`.
@@ -176,14 +176,14 @@ ol.renderer.Map.prototype.removeLayerRendererByKey_ = function(layerKey) {
/**
* Render.
* @param {?oli.FrameState} frameState Frame state.
* @param {?olx.FrameState} frameState Frame state.
*/
ol.renderer.Map.prototype.renderFrame = goog.nullFunction;
/**
* @param {ol.Map} map Map.
* @param {oli.FrameState} frameState Frame state.
* @param {olx.FrameState} frameState Frame state.
* @private
*/
ol.renderer.Map.prototype.removeUnusedLayerRenderers_ =
@@ -198,14 +198,14 @@ ol.renderer.Map.prototype.removeUnusedLayerRenderers_ =
/**
* @param {oli.FrameState} frameState Frame state.
* @param {olx.FrameState} frameState Frame state.
* @protected
*/
ol.renderer.Map.prototype.scheduleExpireIconCache = function(frameState) {
frameState.postRenderFunctions.push(
/**
* @param {ol.Map} map Map.
* @param {oli.FrameState} frameState Frame state.
* @param {olx.FrameState} frameState Frame state.
*/
function(map, frameState) {
ol.style.IconImageCache.getInstance().expire();
@@ -214,7 +214,7 @@ ol.renderer.Map.prototype.scheduleExpireIconCache = function(frameState) {
/**
* @param {!oli.FrameState} frameState Frame state.
* @param {!olx.FrameState} frameState Frame state.
* @protected
*/
ol.renderer.Map.prototype.scheduleRemoveUnusedLayerRenderers =

View File

@@ -88,7 +88,7 @@ goog.inherits(ol.renderer.webgl.Layer, ol.renderer.Layer);
/**
* @param {oli.FrameState} frameState Frame state.
* @param {olx.FrameState} frameState Frame state.
* @param {number} framebufferDimension Framebuffer dimension.
* @protected
*/
@@ -142,7 +142,7 @@ ol.renderer.webgl.Layer.prototype.bindFramebuffer =
/**
* @param {oli.FrameState} frameState Frame state.
* @param {olx.FrameState} frameState Frame state.
* @param {ol.layer.LayerState} layerState Layer state.
* @param {ol.webgl.Context} context Context.
*/
@@ -230,7 +230,7 @@ ol.renderer.webgl.Layer.prototype.composeFrame =
/**
* @param {ol.render.EventType} type Event type.
* @param {ol.webgl.Context} context WebGL context.
* @param {oli.FrameState} frameState Frame state.
* @param {olx.FrameState} frameState Frame state.
* @private
*/
ol.renderer.webgl.Layer.prototype.dispatchComposeEvent_ =

View File

@@ -257,7 +257,7 @@ ol.renderer.webgl.Map.prototype.createLayerRenderer = function(layer) {
/**
* @param {ol.render.EventType} type Event type.
* @param {oli.FrameState} frameState Frame state.
* @param {olx.FrameState} frameState Frame state.
* @private
*/
ol.renderer.webgl.Map.prototype.dispatchComposeEvent_ =
@@ -297,7 +297,7 @@ ol.renderer.webgl.Map.prototype.disposeInternal = function() {
/**
* @param {ol.Map} map Map.
* @param {oli.FrameState} frameState Frame state.
* @param {olx.FrameState} frameState Frame state.
* @private
*/
ol.renderer.webgl.Map.prototype.expireCache_ = function(map, frameState) {