Partial valid-jsdoc corrections

package.json

@@ -54,8 +54,8 @@
     "clean-css": "3.4.9",
     "coveralls": "2.11.6",
     "debounce": "^1.0.0",
-    "eslint": "v2.0.0-alpha-2",
-    "eslint-config-openlayers": "^1.0.0",
+    "eslint": "git://github.com/eslint/eslint.git#4356532469ec1b9d4977aff05a03c3e167922ffa",
+    "eslint-config-openlayers": "^2.0.0",
     "expect.js": "0.3.1",
     "gaze": "^0.5.1",
     "istanbul": "0.4.1",
@@ -83,7 +83,9 @@
       "proj4": false
     },
     "rules": {
-      "no-multiple-empty-lines": [2, {"max": 3, "maxEOF": 1}]
+      "no-constant-condition": 0,
+      "no-multiple-empty-lines": [2, {"max": 3, "maxEOF": 1}],
+      "indent": 0
     }
   },
   "ext": [

src/ol/centerconstraint.js

@@ -12,7 +12,7 @@ ol.CenterConstraintType;
 
 /**
  * @param {ol.Extent} extent Extent.
- * @return {ol.CenterConstraintType}
+ * @return {ol.CenterConstraintType} The constraint.
  */
 ol.CenterConstraint.createExtent = function(extent) {
   return (

src/ol/dom/dom.js

@@ -14,7 +14,7 @@ goog.require('ol');
  * Create an html canvas element and returns its 2d context.
  * @param {number=} opt_width Canvas width.
  * @param {number=} opt_height Canvas height.
- * @return {CanvasRenderingContext2D}
+ * @return {CanvasRenderingContext2D} The context.
  */
 ol.dom.createCanvasContext2D = function(opt_width, opt_height) {
   var canvas = document.createElement('CANVAS');
@@ -196,7 +196,7 @@ ol.dom.transformElement2D = function(element, transform, opt_precision) {
  * padding and border.
  * Equivalent to jQuery's `$(el).outerWidth(true)`.
  * @param {!Element} element Element.
- * @return {number}
+ * @return {number} The width.
  */
 ol.dom.outerWidth = function(element) {
   var width = element.offsetWidth;
@@ -212,7 +212,7 @@ ol.dom.outerWidth = function(element) {
  * padding and border.
  * Equivalent to jQuery's `$(el).outerHeight(true)`.
  * @param {!Element} element Element.
- * @return {number}
+ * @return {number} The height.
  */
 ol.dom.outerHeight = function(element) {
   var height = element.offsetHeight;

src/ol/geom/flat/flipflatgeom.js

@@ -24,12 +24,12 @@ ol.geom.flat.flip.flipXY =
     dest = [];
     destOffset = 0;
   }
-  var j, k;
-  for (j = offset; j < end; ) {
+  var j = offset;
+  while (j < end) {
     var x = flatCoordinates[j++];
     dest[destOffset++] = flatCoordinates[j++];
     dest[destOffset++] = x;
-    for (k = 2; k < stride; ++k) {
+    for (var k = 2; k < stride; ++k) {
       dest[destOffset++] = flatCoordinates[j++];
     }
   }

src/ol/pointer/touchsource.js

@@ -40,8 +40,8 @@ goog.require('ol.pointer.MouseSource');
 
 /**
  * @constructor
- * @param {ol.pointer.PointerEventHandler} dispatcher
- * @param {ol.pointer.MouseSource} mouseSource
+ * @param {ol.pointer.PointerEventHandler} dispatcher The event handler.
+ * @param {ol.pointer.MouseSource} mouseSource Mouse source.
  * @extends {ol.pointer.EventSource}
  */
 ol.pointer.TouchSource = function(dispatcher, mouseSource) {
@@ -111,7 +111,7 @@ ol.pointer.TouchSource.POINTER_TYPE = 'touch';
 
 /**
  * @private
- * @param {Touch} inTouch
+ * @param {Touch} inTouch The in touch.
  * @return {boolean} True, if this is the primary touch.
  */
 ol.pointer.TouchSource.prototype.isPrimaryTouch_ = function(inTouch) {
@@ -121,7 +121,7 @@ ol.pointer.TouchSource.prototype.isPrimaryTouch_ = function(inTouch) {
 
 /**
  * Set primary touch if there are no pointers, or the only pointer is the mouse.
- * @param {Touch} inTouch
+ * @param {Touch} inTouch The in touch.
  * @private
  */
 ol.pointer.TouchSource.prototype.setPrimaryTouch_ = function(inTouch) {
@@ -136,7 +136,7 @@ ol.pointer.TouchSource.prototype.setPrimaryTouch_ = function(inTouch) {
 
 /**
  * @private
- * @param {Object} inPointer
+ * @param {Object} inPointer The in pointer object.
  */
 ol.pointer.TouchSource.prototype.removePrimaryPointer_ = function(inPointer) {
   if (inPointer.isPrimary) {
@@ -237,8 +237,8 @@ ol.pointer.TouchSource.prototype.processTouches_ =
 
 /**
  * @private
- * @param {TouchList} touchList
- * @param {number} searchId
+ * @param {TouchList} touchList The touch list.
+ * @param {number} searchId Search identifier.
  * @return {boolean} True, if the `Touch` with the given id is in the list.
  */
 ol.pointer.TouchSource.prototype.findTouch_ = function(touchList, searchId) {
@@ -263,7 +263,7 @@ ol.pointer.TouchSource.prototype.findTouch_ = function(touchList, searchId) {
  * this "abandoned" touch
  *
  * @private
- * @param {goog.events.BrowserEvent} inEvent
+ * @param {goog.events.BrowserEvent} inEvent The in event.
  */
 ol.pointer.TouchSource.prototype.vacuumTouches_ = function(inEvent) {
   var touchList = inEvent.getBrowserEvent().touches;
@@ -296,7 +296,7 @@ ol.pointer.TouchSource.prototype.vacuumTouches_ = function(inEvent) {
  * Handler for `touchstart`, triggers `pointerover`,
  * `pointerenter` and `pointerdown` events.
  *
- * @param {goog.events.BrowserEvent} inEvent
+ * @param {goog.events.BrowserEvent} inEvent The in event.
  */
 ol.pointer.TouchSource.prototype.touchstart = function(inEvent) {
   this.vacuumTouches_(inEvent);
@@ -309,8 +309,8 @@ ol.pointer.TouchSource.prototype.touchstart = function(inEvent) {
 
 /**
  * @private
- * @param {goog.events.BrowserEvent} browserEvent
- * @param {Object} inPointer
+ * @param {goog.events.BrowserEvent} browserEvent The event.
+ * @param {Object} inPointer The in pointer object.
  */
 ol.pointer.TouchSource.prototype.overDown_ = function(browserEvent, inPointer) {
   this.pointerMap[inPointer.pointerId] = {
@@ -327,7 +327,7 @@ ol.pointer.TouchSource.prototype.overDown_ = function(browserEvent, inPointer) {
 /**
  * Handler for `touchmove`.
  *
- * @param {goog.events.BrowserEvent} inEvent
+ * @param {goog.events.BrowserEvent} inEvent The in event.
  */
 ol.pointer.TouchSource.prototype.touchmove = function(inEvent) {
   inEvent.preventDefault();
@@ -375,7 +375,7 @@ ol.pointer.TouchSource.prototype.moveOverOut_ =
  * Handler for `touchend`, triggers `pointerup`,
  * `pointerout` and `pointerleave` events.
  *
- * @param {goog.events.BrowserEvent} inEvent
+ * @param {goog.events.BrowserEvent} inEvent The event.
  */
 ol.pointer.TouchSource.prototype.touchend = function(inEvent) {
   this.dedupSynthMouse_(inEvent);
@@ -385,8 +385,8 @@ ol.pointer.TouchSource.prototype.touchend = function(inEvent) {
 
 /**
  * @private
- * @param {goog.events.BrowserEvent} browserEvent
- * @param {Object} inPointer
+ * @param {goog.events.BrowserEvent} browserEvent An event.
+ * @param {Object} inPointer The inPointer object.
  */
 ol.pointer.TouchSource.prototype.upOut_ = function(browserEvent, inPointer) {
   this.dispatcher.up(inPointer, browserEvent);
@@ -400,7 +400,7 @@ ol.pointer.TouchSource.prototype.upOut_ = function(browserEvent, inPointer) {
  * Handler for `touchcancel`, triggers `pointercancel`,
  * `pointerout` and `pointerleave` events.
  *
- * @param {goog.events.BrowserEvent} inEvent
+ * @param {goog.events.BrowserEvent} inEvent The in event.
  */
 ol.pointer.TouchSource.prototype.touchcancel = function(inEvent) {
   this.processTouches_(inEvent, this.cancelOut_);
@@ -423,7 +423,7 @@ ol.pointer.TouchSource.prototype.cancelOut_ =
 
 /**
  * @private
- * @param {Object} inPointer
+ * @param {Object} inPointer The inPointer object.
  */
 ol.pointer.TouchSource.prototype.cleanUpPointer_ = function(inPointer) {
   delete this.pointerMap[inPointer.pointerId];
@@ -435,7 +435,7 @@ ol.pointer.TouchSource.prototype.cleanUpPointer_ = function(inPointer) {
  * Prevent synth mouse events from creating pointer events.
  *
  * @private
- * @param {goog.events.BrowserEvent} inEvent
+ * @param {goog.events.BrowserEvent} inEvent The in event.
  */
 ol.pointer.TouchSource.prototype.dedupSynthMouse_ = function(inEvent) {
   var lts = this.mouseSource.lastTouches;

src/ol/render/ireplay.js

@@ -34,6 +34,11 @@ ol.render.IReplayGroup = function() {
 };
 
 
+/* eslint-disable valid-jsdoc */
+// TODO: enable valid-jsdoc for @interface methods when this issue is resolved
+// https://github.com/eslint/eslint/issues/4887
+
+
 /**
  * @param {number|undefined} zIndex Z index.
  * @param {ol.render.ReplayType} replayType Replay type.

src/ol/renderer/maprenderer.js

@@ -382,9 +382,9 @@ ol.renderer.Map.prototype.scheduleRemoveUnusedLayerRenderers =
 
 
 /**
- * @param {ol.layer.LayerState} state1
- * @param {ol.layer.LayerState} state2
- * @return {number}
+ * @param {ol.layer.LayerState} state1 First layer state.
+ * @param {ol.layer.LayerState} state2 Second layer state.
+ * @return {number} The zIndex difference.
  */
 ol.renderer.Map.sortByZIndex = function(state1, state2) {
   return state1.zIndex - state2.zIndex;

src/ol/renderer/webgl/webglmaprenderer.js

@@ -344,7 +344,7 @@ ol.renderer.webgl.Map.prototype.expireCache_ = function(map, frameState) {
 
 
 /**
- * @return {ol.webgl.Context}
+ * @return {ol.webgl.Context} The context.
  */
 ol.renderer.webgl.Map.prototype.getContext = function() {
   return this.context_;

src/ol/reproj/triangulation.js

@@ -48,8 +48,8 @@ ol.reproj.Triangulation = function(sourceProj, targetProj, targetExtent,
   var transformInv = ol.proj.getTransform(this.targetProj_, this.sourceProj_);
 
   /**
-   * @param {ol.Coordinate} c
-   * @return {ol.Coordinate}
+   * @param {ol.Coordinate} c A coordinate.
+   * @return {ol.Coordinate} Transformed coordinate.
    * @private
    */
   this.transformInv_ = function(c) {
@@ -173,12 +173,12 @@ ol.reproj.Triangulation = function(sourceProj, targetProj, targetExtent,
 
 /**
  * Adds triangle to the triangulation.
- * @param {ol.Coordinate} a
- * @param {ol.Coordinate} b
- * @param {ol.Coordinate} c
- * @param {ol.Coordinate} aSrc
- * @param {ol.Coordinate} bSrc
- * @param {ol.Coordinate} cSrc
+ * @param {ol.Coordinate} a The target a coordinate.
+ * @param {ol.Coordinate} b The target b coordinate.
+ * @param {ol.Coordinate} c The target c coordinate.
+ * @param {ol.Coordinate} aSrc The source a coordinate.
+ * @param {ol.Coordinate} bSrc The source b coordinate.
+ * @param {ol.Coordinate} cSrc The source c coordinate.
  * @private
  */
 ol.reproj.Triangulation.prototype.addTriangle_ = function(a, b, c,
@@ -195,14 +195,14 @@ ol.reproj.Triangulation.prototype.addTriangle_ = function(a, b, c,
  * (and reprojects the vertices) if valid.
  * Performs quad subdivision if needed to increase precision.
  *
- * @param {ol.Coordinate} a
- * @param {ol.Coordinate} b
- * @param {ol.Coordinate} c
- * @param {ol.Coordinate} d
- * @param {ol.Coordinate} aSrc
- * @param {ol.Coordinate} bSrc
- * @param {ol.Coordinate} cSrc
- * @param {ol.Coordinate} dSrc
+ * @param {ol.Coordinate} a The target a coordinate.
+ * @param {ol.Coordinate} b The target b coordinate.
+ * @param {ol.Coordinate} c The target c coordinate.
+ * @param {ol.Coordinate} d The target d coordinate.
+ * @param {ol.Coordinate} aSrc The source a coordinate.
+ * @param {ol.Coordinate} bSrc The source b coordinate.
+ * @param {ol.Coordinate} cSrc The source c coordinate.
+ * @param {ol.Coordinate} dSrc The source d coordinate.
  * @param {number} maxSubdivision Maximal allowed subdivision of the quad.
  * @private
  */

src/ol/size.js

@@ -18,7 +18,7 @@ ol.Size;
  * @param {ol.Size} size Size.
  * @param {number} buffer Buffer.
  * @param {ol.Size=} opt_size Optional reusable size array.
- * @return {ol.Size}
+ * @return {ol.Size} The buffered size.
  */
 ol.size.buffer = function(size, buffer, opt_size) {
   if (opt_size === undefined) {
@@ -56,7 +56,7 @@ ol.size.hasArea = function(size) {
  * @param {ol.Size} size Size.
  * @param {number} ratio Ratio.
  * @param {ol.Size=} opt_size Optional reusable size array.
- * @return {ol.Size}
+ * @return {ol.Size} The scaled size.
  */
 ol.size.scale = function(size, ratio, opt_size) {
   if (opt_size === undefined) {

src/ol/source/clustersource.js

@@ -19,7 +19,7 @@ goog.require('ol.source.Vector');
  * Layer source to cluster vector data.
  *
  * @constructor
- * @param {olx.source.ClusterOptions} options
+ * @param {olx.source.ClusterOptions} options Constructor options.
  * @extends {ol.source.Vector}
  * @api
  */
@@ -148,7 +148,7 @@ ol.source.Cluster.prototype.cluster_ = function() {
 
 /**
  * @param {Array.<ol.Feature>} features Features
- * @return {ol.Feature}
+ * @return {ol.Feature} The cluster feature.
  * @private
  */
 ol.source.Cluster.prototype.createCluster_ = function(features) {

src/ol/source/imagecanvassource.js

@@ -13,7 +13,7 @@ goog.require('ol.source.Image');
  *
  * @constructor
  * @extends {ol.source.Image}
- * @param {olx.source.ImageCanvasOptions} options
+ * @param {olx.source.ImageCanvasOptions} options Constructor options.
  * @api
  */
 ol.source.ImageCanvas = function(options) {

src/ol/source/tileutfgridsource.js

@@ -269,7 +269,7 @@ ol.source.TileUTFGridTile_.prototype.getImage = function(opt_context) {
 /**
  * Synchronously returns data at given coordinate (if available).
  * @param {ol.Coordinate} coordinate Coordinate.
- * @return {Object}
+ * @return {Object} The data.
  */
 ol.source.TileUTFGridTile_.prototype.getData = function(coordinate) {
   if (!this.grid_ || !this.keys_ || !this.data_) {
@@ -346,7 +346,7 @@ ol.source.TileUTFGridTile_.prototype.handleError_ = function() {
 
 
 /**
- * @param {!UTFGridJSON} json
+ * @param {!UTFGridJSON} json UTFGrid data.
  * @private
  */
 ol.source.TileUTFGridTile_.prototype.handleLoad_ = function(json) {

src/ol/source/vectorsource.js

@@ -221,8 +221,8 @@ ol.source.Vector.prototype.addFeatureInternal = function(feature) {
 
 
 /**
- * @param {string} featureKey
- * @param {ol.Feature} feature
+ * @param {string} featureKey Unique identifier for the feature.
+ * @param {ol.Feature} feature The feature.
  * @private
  */
 ol.source.Vector.prototype.setupChangeEvents_ = function(featureKey, feature) {
@@ -240,10 +240,10 @@ ol.source.Vector.prototype.setupChangeEvents_ = function(featureKey, feature) {
 
 
 /**
- * @param {string} featureKey
- * @param {ol.Feature} feature
- * @return {boolean} `true` if the feature is "valid", in the sense that it is
- *     also a candidate for insertion into the Rtree, otherwise `false`.
+ * @param {string} featureKey Unique identifier for the feature.
+ * @param {ol.Feature} feature The feature.
+ * @return {boolean} The feature is "valid", in the sense that it is also a
+ *     candidate for insertion into the Rtree.
  * @private
  */
 ol.source.Vector.prototype.addToIndex_ = function(featureKey, feature) {
@@ -536,7 +536,7 @@ ol.source.Vector.prototype.forEachFeatureIntersectingExtent =
  * Get the features collection associated with this source. Will be `null`
  * unless the source was configured with `useSpatialIndex` set to `false`, or
  * with an {@link ol.Collection} as `features`.
- * @return {ol.Collection.<ol.Feature>}
+ * @return {ol.Collection.<ol.Feature>} The collection of features.
  * @api
  */
 ol.source.Vector.prototype.getFeaturesCollection = function() {

src/ol/style/atlasmanager.js

@@ -311,7 +311,7 @@ ol.style.Atlas = function(size, space) {
 
 /**
  * @param {string} id The identifier of the entry to check.
- * @return {?ol.style.AtlasInfo}
+ * @return {?ol.style.AtlasInfo} The atlas info.
  */
 ol.style.Atlas.prototype.get = function(id) {
   return /** @type {?ol.style.AtlasInfo} */ (

src/ol/style/circlestyle.js

@@ -235,7 +235,7 @@ ol.style.Circle.RenderOptions;
 
 /**
  * @private
- * @param {ol.style.AtlasManager|undefined} atlasManager
+ * @param {ol.style.AtlasManager|undefined} atlasManager An atlas manager.
  */
 ol.style.Circle.prototype.render_ = function(atlasManager) {
   var imageSize;
@@ -323,8 +323,8 @@ ol.style.Circle.prototype.render_ = function(atlasManager) {
 
 /**
  * @private
- * @param {ol.style.Circle.RenderOptions} renderOptions
- * @param {CanvasRenderingContext2D} context
+ * @param {ol.style.Circle.RenderOptions} renderOptions Render options.
+ * @param {CanvasRenderingContext2D} context The rendering context.
  * @param {number} x The origin for the symbol (x).
  * @param {number} y The origin for the symbol (y).
  */
@@ -358,7 +358,7 @@ ol.style.Circle.prototype.draw_ = function(renderOptions, context, x, y) {
 
 /**
  * @private
- * @param {ol.style.Circle.RenderOptions} renderOptions
+ * @param {ol.style.Circle.RenderOptions} renderOptions Render options.
  */
 ol.style.Circle.prototype.createHitDetectionCanvas_ = function(renderOptions) {
   this.hitDetectionImageSize_ = [renderOptions.size, renderOptions.size];

src/ol/style/regularshapestyle.js

@@ -298,7 +298,7 @@ ol.style.RegularShape.RenderOptions;
 
 /**
  * @private
- * @param {ol.style.AtlasManager|undefined} atlasManager
+ * @param {ol.style.AtlasManager|undefined} atlasManager An atlas manager.
  */
 ol.style.RegularShape.prototype.render_ = function(atlasManager) {
   var imageSize;
@@ -403,8 +403,8 @@ ol.style.RegularShape.prototype.render_ = function(atlasManager) {
 
 /**
  * @private
- * @param {ol.style.RegularShape.RenderOptions} renderOptions
- * @param {CanvasRenderingContext2D} context
+ * @param {ol.style.RegularShape.RenderOptions} renderOptions Render options.
+ * @param {CanvasRenderingContext2D} context The rendering context.
  * @param {number} x The origin for the symbol (x).
  * @param {number} y The origin for the symbol (y).
  */

src/ol/tile.js

@@ -91,7 +91,7 @@ ol.Tile.prototype.getKey = function() {
 
 /**
  * Get the tile coordinate for this tile.
- * @return {ol.TileCoord}
+ * @return {ol.TileCoord} The tile coordinate.
  * @api
  */
 ol.Tile.prototype.getTileCoord = function() {

src/ol/vectortile.js

@@ -92,7 +92,7 @@ goog.inherits(ol.VectorTile, ol.Tile);
 
 
 /**
- * @return {CanvasRenderingContext2D}
+ * @return {CanvasRenderingContext2D} The rendering context.
  */
 ol.VectorTile.prototype.getContext = function() {
   return this.context_;
@@ -126,7 +126,7 @@ ol.VectorTile.prototype.getFeatures = function() {
 
 
 /**
- * @return {ol.TileReplayState}
+ * @return {ol.TileReplayState} The replay state.
  */
 ol.VectorTile.prototype.getReplayState = function() {
   return this.replayState_;

src/ol/view.js

@@ -633,7 +633,7 @@ ol.View.prototype.setZoom = function(zoom) {
 /**
  * @param {olx.ViewOptions} options View options.
  * @private
- * @return {ol.CenterConstraintType}
+ * @return {ol.CenterConstraintType} The constraint.
  */
 ol.View.createCenterConstraint_ = function(options) {
   if (options.extent !== undefined) {
@@ -648,7 +648,7 @@ ol.View.createCenterConstraint_ = function(options) {
  * @private
  * @param {olx.ViewOptions} options View options.
  * @return {{constraint: ol.ResolutionConstraintType, maxResolution: number,
- *     minResolution: number}}
+ *     minResolution: number}} The constraint.
  */
 ol.View.createResolutionConstraint_ = function(options) {
   var resolutionConstraint;

src/ol/webgl/context.js

@@ -356,7 +356,7 @@ ol.webgl.Context.prototype.logger_ = goog.log.getLogger('ol.webgl.Context');
  * @param {WebGLRenderingContext} gl WebGL rendering context.
  * @param {number=} opt_wrapS wrapS.
  * @param {number=} opt_wrapT wrapT.
- * @return {WebGLTexture}
+ * @return {WebGLTexture} The texture.
  * @private
  */
 ol.webgl.Context.createTexture_ = function(gl, opt_wrapS, opt_wrapT) {
@@ -384,7 +384,7 @@ ol.webgl.Context.createTexture_ = function(gl, opt_wrapS, opt_wrapT) {
  * @param {number} height Height.
  * @param {number=} opt_wrapS wrapS.
  * @param {number=} opt_wrapT wrapT.
- * @return {WebGLTexture}
+ * @return {WebGLTexture} The texture.
  */
 ol.webgl.Context.createEmptyTexture = function(
     gl, width, height, opt_wrapS, opt_wrapT) {
@@ -402,7 +402,7 @@ ol.webgl.Context.createEmptyTexture = function(
  * @param {HTMLCanvasElement|HTMLImageElement|HTMLVideoElement} image Image.
  * @param {number=} opt_wrapS wrapS.
  * @param {number=} opt_wrapT wrapT.
- * @return {WebGLTexture}
+ * @return {WebGLTexture} The texture.
  */
 ol.webgl.Context.createTexture = function(gl, image, opt_wrapS, opt_wrapT) {
   var texture = ol.webgl.Context.createTexture_(gl, opt_wrapS, opt_wrapT);