From 59a66c7aaa9ffc3d2b64d6333a7a834e5cc29e14 Mon Sep 17 00:00:00 2001 From: Tim Schaub Date: Sat, 9 Jan 2016 11:37:28 -0700 Subject: [PATCH] Remaining valid-jsdoc corrections --- src/ol/color/color.js | 3 - src/ol/format/gml/gml3format.js | 2 +- src/ol/format/gpxformat.js | 2 +- src/ol/format/kmlformat.js | 4 +- src/ol/format/osmxmlformat.js | 2 - src/ol/format/owsformat.js | 28 ++++----- src/ol/format/wktformat.js | 2 +- src/ol/format/xmlformat.js | 2 +- src/ol/interaction/drawinteraction.js | 10 ++-- src/ol/interaction/modifyinteraction.js | 6 +- src/ol/interaction/pointerinteraction.js | 2 +- src/ol/interaction/snapinteraction.js | 8 +-- src/ol/layer/heatmaplayer.js | 6 +- src/ol/mapbrowserevent.js | 2 +- src/ol/overlay.js | 8 +-- src/ol/pointer/eventsource.js | 7 ++- src/ol/pointer/mousesource.js | 22 +++---- src/ol/pointer/mssource.js | 24 ++++---- src/ol/pointer/nativesource.js | 18 +++--- src/ol/pointer/pointerevent.js | 12 ++-- src/ol/pointer/pointereventhandler.js | 58 +++++++++---------- src/ol/pointer/touchsource.js | 12 ++-- src/ol/renderer/canvas/canvaslayerrenderer.js | 2 +- .../renderer/webgl/webglimagelayerrenderer.js | 6 +- src/ol/style/circlestyle.js | 4 +- src/ol/style/regularshapestyle.js | 6 +- 26 files changed, 128 insertions(+), 130 deletions(-) diff --git a/src/ol/color/color.js b/src/ol/color/color.js index 81225c3bc6..105fe5e387 100644 --- a/src/ol/color/color.js +++ b/src/ol/color/color.js @@ -145,9 +145,6 @@ ol.color.equals = function(color1, color2) { * @return {ol.Color} Color. */ ol.color.fromString = ( - /** - * @return {function(string): ol.Color} - */ function() { // We maintain a small cache of parsed strings. To provide cheap LRU-like diff --git a/src/ol/format/gml/gml3format.js b/src/ol/format/gml/gml3format.js index 4248ab411b..9b1792661b 100644 --- a/src/ol/format/gml/gml3format.js +++ b/src/ol/format/gml/gml3format.js @@ -661,7 +661,7 @@ ol.format.GML3.prototype.writePos_ = function(node, value, objectStack) { /** * @param {Array.} point Point geometry. * @param {string=} opt_srsName Optional srsName - * @return {string} + * @return {string} The coords string. * @private */ ol.format.GML3.prototype.getCoords_ = function(point, opt_srsName) { diff --git a/src/ol/format/gpxformat.js b/src/ol/format/gpxformat.js index 19cbe93aa8..51b6aed20f 100644 --- a/src/ol/format/gpxformat.js +++ b/src/ol/format/gpxformat.js @@ -413,7 +413,7 @@ ol.format.GPX.WPT_PARSERS_ = ol.xml.makeStructureNS( /** - * @param {Array.} features + * @param {Array.} features List of features. * @private */ ol.format.GPX.prototype.handleReadExtensions_ = function(features) { diff --git a/src/ol/format/kmlformat.js b/src/ol/format/kmlformat.js index 93b7a49b87..8414635e7d 100644 --- a/src/ol/format/kmlformat.js +++ b/src/ol/format/kmlformat.js @@ -1164,8 +1164,8 @@ ol.format.KML.readStyle_ = function(node, objectStack) { * Reads an array of geometries and creates arrays for common geometry * properties. Then sets them to the multi geometry. * @param {ol.geom.MultiPoint|ol.geom.MultiLineString|ol.geom.MultiPolygon} - * multiGeometry - * @param {Array.} geometries + * multiGeometry A multi-geometry. + * @param {Array.} geometries List of geometries. * @private */ ol.format.KML.setCommonGeometryProperties_ = function(multiGeometry, diff --git a/src/ol/format/osmxmlformat.js b/src/ol/format/osmxmlformat.js index f45ca8211d..3ad1d48fce 100644 --- a/src/ol/format/osmxmlformat.js +++ b/src/ol/format/osmxmlformat.js @@ -128,7 +128,6 @@ ol.format.OSMXML.readWay_ = function(node, objectStack) { * @param {Node} node Node. * @param {Array.<*>} objectStack Object stack. * @private - * @return {ol.Feature|undefined} Track. */ ol.format.OSMXML.readNd_ = function(node, objectStack) { goog.asserts.assert(node.nodeType == goog.dom.NodeType.ELEMENT, @@ -143,7 +142,6 @@ ol.format.OSMXML.readNd_ = function(node, objectStack) { * @param {Node} node Node. * @param {Array.<*>} objectStack Object stack. * @private - * @return {ol.Feature|undefined} Track. */ ol.format.OSMXML.readTag_ = function(node, objectStack) { goog.asserts.assert(node.nodeType == goog.dom.NodeType.ELEMENT, diff --git a/src/ol/format/owsformat.js b/src/ol/format/owsformat.js index 701abb25b2..fe990ce425 100644 --- a/src/ol/format/owsformat.js +++ b/src/ol/format/owsformat.js @@ -52,7 +52,7 @@ ol.format.OWS.prototype.readFromNode = function(node) { * @param {Node} node Node. * @param {Array.<*>} objectStack Object stack. * @private - * @return {Object|undefined} + * @return {Object|undefined} The address. */ ol.format.OWS.readAddress_ = function(node, objectStack) { goog.asserts.assert(node.nodeType == goog.dom.NodeType.ELEMENT, @@ -68,7 +68,7 @@ ol.format.OWS.readAddress_ = function(node, objectStack) { * @param {Node} node Node. * @param {Array.<*>} objectStack Object stack. * @private - * @return {Object|undefined} + * @return {Object|undefined} The values. */ ol.format.OWS.readAllowedValues_ = function(node, objectStack) { goog.asserts.assert(node.nodeType == goog.dom.NodeType.ELEMENT, @@ -84,7 +84,7 @@ ol.format.OWS.readAllowedValues_ = function(node, objectStack) { * @param {Node} node Node. * @param {Array.<*>} objectStack Object stack. * @private - * @return {Object|undefined} + * @return {Object|undefined} The constraint. */ ol.format.OWS.readConstraint_ = function(node, objectStack) { goog.asserts.assert(node.nodeType == goog.dom.NodeType.ELEMENT, @@ -105,7 +105,7 @@ ol.format.OWS.readConstraint_ = function(node, objectStack) { * @param {Node} node Node. * @param {Array.<*>} objectStack Object stack. * @private - * @return {Object|undefined} + * @return {Object|undefined} The contact info. */ ol.format.OWS.readContactInfo_ = function(node, objectStack) { goog.asserts.assert(node.nodeType == goog.dom.NodeType.ELEMENT, @@ -121,7 +121,7 @@ ol.format.OWS.readContactInfo_ = function(node, objectStack) { * @param {Node} node Node. * @param {Array.<*>} objectStack Object stack. * @private - * @return {Object|undefined} + * @return {Object|undefined} The DCP. */ ol.format.OWS.readDcp_ = function(node, objectStack) { goog.asserts.assert(node.nodeType == goog.dom.NodeType.ELEMENT, @@ -136,7 +136,7 @@ ol.format.OWS.readDcp_ = function(node, objectStack) { * @param {Node} node Node. * @param {Array.<*>} objectStack Object stack. * @private - * @return {Object|undefined} + * @return {Object|undefined} The GET object. */ ol.format.OWS.readGet_ = function(node, objectStack) { goog.asserts.assert(node.nodeType == goog.dom.NodeType.ELEMENT, @@ -155,7 +155,7 @@ ol.format.OWS.readGet_ = function(node, objectStack) { * @param {Node} node Node. * @param {Array.<*>} objectStack Object stack. * @private - * @return {Object|undefined} + * @return {Object|undefined} The HTTP object. */ ol.format.OWS.readHttp_ = function(node, objectStack) { goog.asserts.assert(node.nodeType == goog.dom.NodeType.ELEMENT, @@ -170,7 +170,7 @@ ol.format.OWS.readHttp_ = function(node, objectStack) { * @param {Node} node Node. * @param {Array.<*>} objectStack Object stack. * @private - * @return {Object|undefined} + * @return {Object|undefined} The operation. */ ol.format.OWS.readOperation_ = function(node, objectStack) { goog.asserts.assert(node.nodeType == goog.dom.NodeType.ELEMENT, @@ -195,7 +195,7 @@ ol.format.OWS.readOperation_ = function(node, objectStack) { * @param {Node} node Node. * @param {Array.<*>} objectStack Object stack. * @private - * @return {Object|undefined} + * @return {Object|undefined} The operations metadata. */ ol.format.OWS.readOperationsMetadata_ = function(node, objectStack) { @@ -213,7 +213,7 @@ ol.format.OWS.readOperationsMetadata_ = function(node, * @param {Node} node Node. * @param {Array.<*>} objectStack Object stack. * @private - * @return {Object|undefined} + * @return {Object|undefined} The phone. */ ol.format.OWS.readPhone_ = function(node, objectStack) { goog.asserts.assert(node.nodeType == goog.dom.NodeType.ELEMENT, @@ -228,7 +228,7 @@ ol.format.OWS.readPhone_ = function(node, objectStack) { * @param {Node} node Node. * @param {Array.<*>} objectStack Object stack. * @private - * @return {Object|undefined} + * @return {Object|undefined} The service identification. */ ol.format.OWS.readServiceIdentification_ = function(node, objectStack) { @@ -246,7 +246,7 @@ ol.format.OWS.readServiceIdentification_ = function(node, * @param {Node} node Node. * @param {Array.<*>} objectStack Object stack. * @private - * @return {Object|undefined} + * @return {Object|undefined} The service contact. */ ol.format.OWS.readServiceContact_ = function(node, objectStack) { goog.asserts.assert(node.nodeType == goog.dom.NodeType.ELEMENT, @@ -263,7 +263,7 @@ ol.format.OWS.readServiceContact_ = function(node, objectStack) { * @param {Node} node Node. * @param {Array.<*>} objectStack Object stack. * @private - * @return {Object|undefined} + * @return {Object|undefined} The service provider. */ ol.format.OWS.readServiceProvider_ = function(node, objectStack) { goog.asserts.assert(node.nodeType == goog.dom.NodeType.ELEMENT, @@ -280,7 +280,7 @@ ol.format.OWS.readServiceProvider_ = function(node, objectStack) { * @param {Node} node Node. * @param {Array.<*>} objectStack Object stack. * @private - * @return {string|undefined} + * @return {string|undefined} The value. */ ol.format.OWS.readValue_ = function(node, objectStack) { goog.asserts.assert(node.nodeType == goog.dom.NodeType.ELEMENT, diff --git a/src/ol/format/wktformat.js b/src/ol/format/wktformat.js index 843c64ea40..e81b8271d1 100644 --- a/src/ol/format/wktformat.js +++ b/src/ol/format/wktformat.js @@ -527,7 +527,7 @@ ol.format.WKT.Lexer.prototype.readText_ = function() { /** * Class to parse the tokens from the WKT string. - * @param {ol.format.WKT.Lexer} lexer + * @param {ol.format.WKT.Lexer} lexer The lexer. * @constructor * @protected */ diff --git a/src/ol/format/xmlformat.js b/src/ol/format/xmlformat.js index 11d46fbe6a..0ec41bcf9d 100644 --- a/src/ol/format/xmlformat.js +++ b/src/ol/format/xmlformat.js @@ -17,7 +17,7 @@ ol.format.XML = function() { /** * @param {Document|Node|string} source Source. - * @return {Object} + * @return {Object} The parsed result. */ ol.format.XML.prototype.read = function(source) { if (ol.xml.isDocument(source)) { diff --git a/src/ol/interaction/drawinteraction.js b/src/ol/interaction/drawinteraction.js index aa8ae8b56f..1c30896f16 100644 --- a/src/ol/interaction/drawinteraction.js +++ b/src/ol/interaction/drawinteraction.js @@ -166,8 +166,9 @@ ol.interaction.Draw = function(options) { if (this.type_ === ol.geom.GeometryType.CIRCLE) { /** * @param {ol.Coordinate|Array.|Array.>} coordinates - * @param {ol.geom.SimpleGeometry=} opt_geometry - * @return {ol.geom.SimpleGeometry} + * The coordinates. + * @param {ol.geom.SimpleGeometry=} opt_geometry Optional geometry. + * @return {ol.geom.SimpleGeometry} A geometry. */ geometryFunction = function(coordinates, opt_geometry) { var circle = opt_geometry ? opt_geometry : @@ -191,8 +192,9 @@ ol.interaction.Draw = function(options) { } /** * @param {ol.Coordinate|Array.|Array.>} coordinates - * @param {ol.geom.SimpleGeometry=} opt_geometry - * @return {ol.geom.SimpleGeometry} + * The coordinates. + * @param {ol.geom.SimpleGeometry=} opt_geometry Optional geometry. + * @return {ol.geom.SimpleGeometry} A geometry. */ geometryFunction = function(coordinates, opt_geometry) { var geometry = opt_geometry; diff --git a/src/ol/interaction/modifyinteraction.js b/src/ol/interaction/modifyinteraction.js index 9dd0ba56cb..bf5ae2f6a3 100644 --- a/src/ol/interaction/modifyinteraction.js +++ b/src/ol/interaction/modifyinteraction.js @@ -533,9 +533,9 @@ ol.interaction.Modify.prototype.createOrUpdateVertexFeature_ = /** - * @param {ol.interaction.SegmentDataType} a - * @param {ol.interaction.SegmentDataType} b - * @return {number} + * @param {ol.interaction.SegmentDataType} a The first segment data. + * @param {ol.interaction.SegmentDataType} b The second segment data. + * @return {number} The difference in indexes. * @private */ ol.interaction.Modify.compareIndexes_ = function(a, b) { diff --git a/src/ol/interaction/pointerinteraction.js b/src/ol/interaction/pointerinteraction.js index f9af8002dc..ca45bb6d03 100644 --- a/src/ol/interaction/pointerinteraction.js +++ b/src/ol/interaction/pointerinteraction.js @@ -87,7 +87,7 @@ goog.inherits(ol.interaction.Pointer, ol.interaction.Interaction); /** - * @param {Array.} pointerEvents + * @param {Array.} pointerEvents List of events. * @return {ol.Pixel} Centroid pixel. */ ol.interaction.Pointer.centroid = function(pointerEvents) { diff --git a/src/ol/interaction/snapinteraction.js b/src/ol/interaction/snapinteraction.js index 670315f2c4..cce0c481a8 100644 --- a/src/ol/interaction/snapinteraction.js +++ b/src/ol/interaction/snapinteraction.js @@ -200,7 +200,7 @@ ol.interaction.Snap.prototype.forEachFeatureRemove_ = function(feature) { /** - * @return {ol.Collection.|Array.} + * @return {ol.Collection.|Array.} Features. * @private */ ol.interaction.Snap.prototype.getFeatures_ = function() { @@ -608,9 +608,9 @@ ol.interaction.Snap.handleUpEvent_ = function(evt) { /** * Sort segments by distance, helper function - * @param {ol.interaction.Snap.SegmentDataType} a - * @param {ol.interaction.Snap.SegmentDataType} b - * @return {number} + * @param {ol.interaction.Snap.SegmentDataType} a The first segment data. + * @param {ol.interaction.Snap.SegmentDataType} b The second segment data. + * @return {number} The difference in distance. * @this {ol.interaction.Snap} */ ol.interaction.Snap.sortByDistance = function(a, b) { diff --git a/src/ol/layer/heatmaplayer.js b/src/ol/layer/heatmaplayer.js index 5c9bfeb428..8d67c1569a 100644 --- a/src/ol/layer/heatmaplayer.js +++ b/src/ol/layer/heatmaplayer.js @@ -145,8 +145,8 @@ ol.layer.Heatmap.DEFAULT_GRADIENT = ['#00f', '#0ff', '#0f0', '#ff0', '#f00']; /** - * @param {Array.} colors - * @return {Uint8ClampedArray} + * @param {Array.} colors A list of colored. + * @return {Uint8ClampedArray} An array. * @private */ ol.layer.Heatmap.createGradient_ = function(colors) { @@ -168,7 +168,7 @@ ol.layer.Heatmap.createGradient_ = function(colors) { /** - * @return {string} + * @return {string} Data URL for a circle. * @private */ ol.layer.Heatmap.prototype.createCircle_ = function() { diff --git a/src/ol/mapbrowserevent.js b/src/ol/mapbrowserevent.js index bc1ff6594f..0a2db5f0e6 100644 --- a/src/ol/mapbrowserevent.js +++ b/src/ol/mapbrowserevent.js @@ -403,7 +403,7 @@ ol.MapBrowserEventHandler.prototype.relayEvent_ = function(pointerEvent) { /** * @param {ol.pointer.PointerEvent} pointerEvent Pointer event. - * @return {boolean} + * @return {boolean} Is moving. * @private */ ol.MapBrowserEventHandler.prototype.isMoving_ = function(pointerEvent) { diff --git a/src/ol/overlay.js b/src/ol/overlay.js index 9c0ad495c0..be0a1cd8f5 100644 --- a/src/ol/overlay.js +++ b/src/ol/overlay.js @@ -437,7 +437,7 @@ ol.Overlay.prototype.panIntoView_ = function() { * Get the extent of an element relative to the document * @param {Element|undefined} element The element. * @param {ol.Size|undefined} size The size of the element. - * @return {ol.Extent} + * @return {ol.Extent} The extent. * @private */ ol.Overlay.prototype.getRect_ = function(element, size) { @@ -468,7 +468,7 @@ ol.Overlay.prototype.setPositioning = function(positioning) { /** * Modify the visibility of the element. - * @param {boolean} visible + * @param {boolean} visible Element visibility. * @protected */ ol.Overlay.prototype.setVisible = function(visible) { @@ -498,8 +498,8 @@ ol.Overlay.prototype.updatePixelPosition = function() { /** - * @param {ol.Pixel} pixel - * @param {ol.Size|undefined} mapSize + * @param {ol.Pixel} pixel The pixel location. + * @param {ol.Size|undefined} mapSize The map size. * @protected */ ol.Overlay.prototype.updateRenderedPosition = function(pixel, mapSize) { diff --git a/src/ol/pointer/eventsource.js b/src/ol/pointer/eventsource.js index 4afe449c51..af72905be3 100644 --- a/src/ol/pointer/eventsource.js +++ b/src/ol/pointer/eventsource.js @@ -5,8 +5,9 @@ goog.require('goog.events.BrowserEvent'); /** - * @param {ol.pointer.PointerEventHandler} dispatcher - * @param {!Object.} mapping + * @param {ol.pointer.PointerEventHandler} dispatcher Event handler. + * @param {!Object.} mapping Event + * mapping. * @constructor */ ol.pointer.EventSource = function(dispatcher, mapping) { @@ -46,7 +47,7 @@ ol.pointer.EventSource.prototype.getMapping = function() { /** * Returns the handler that should handle a given event type. - * @param {string} eventType + * @param {string} eventType The event type. * @return {function(goog.events.BrowserEvent)} Handler */ ol.pointer.EventSource.prototype.getHandlerForEvent = function(eventType) { diff --git a/src/ol/pointer/mousesource.js b/src/ol/pointer/mousesource.js index 618541604e..d054a51f36 100644 --- a/src/ol/pointer/mousesource.js +++ b/src/ol/pointer/mousesource.js @@ -35,7 +35,7 @@ goog.require('ol.pointer.EventSource'); /** - * @param {ol.pointer.PointerEventHandler} dispatcher + * @param {ol.pointer.PointerEventHandler} dispatcher Event handler. * @constructor * @extends {ol.pointer.EventSource} */ @@ -108,7 +108,7 @@ ol.pointer.MouseSource.DEDUP_DIST = 25; * or detect that the positions are invalid. * * @private - * @param {goog.events.BrowserEvent} inEvent + * @param {goog.events.BrowserEvent} inEvent The in event. * @return {boolean} True, if the event was generated by a touch. */ ol.pointer.MouseSource.prototype.isEventSimulatedFromTouch_ = @@ -131,9 +131,9 @@ ol.pointer.MouseSource.prototype.isEventSimulatedFromTouch_ = * Creates a copy of the original event that will be used * for the fake pointer event. * - * @param {goog.events.BrowserEvent} inEvent - * @param {ol.pointer.PointerEventHandler} dispatcher - * @return {Object} + * @param {goog.events.BrowserEvent} inEvent The in event. + * @param {ol.pointer.PointerEventHandler} dispatcher Event handler. + * @return {Object} The copied event. */ ol.pointer.MouseSource.prepareEvent = function(inEvent, dispatcher) { var e = dispatcher.cloneEvent(inEvent, inEvent.getBrowserEvent()); @@ -156,7 +156,7 @@ ol.pointer.MouseSource.prepareEvent = function(inEvent, dispatcher) { /** * Handler for `mousedown`. * - * @param {goog.events.BrowserEvent} inEvent + * @param {goog.events.BrowserEvent} inEvent The in event. */ ol.pointer.MouseSource.prototype.mousedown = function(inEvent) { if (!this.isEventSimulatedFromTouch_(inEvent)) { @@ -175,7 +175,7 @@ ol.pointer.MouseSource.prototype.mousedown = function(inEvent) { /** * Handler for `mousemove`. * - * @param {goog.events.BrowserEvent} inEvent + * @param {goog.events.BrowserEvent} inEvent The in event. */ ol.pointer.MouseSource.prototype.mousemove = function(inEvent) { if (!this.isEventSimulatedFromTouch_(inEvent)) { @@ -188,7 +188,7 @@ ol.pointer.MouseSource.prototype.mousemove = function(inEvent) { /** * Handler for `mouseup`. * - * @param {goog.events.BrowserEvent} inEvent + * @param {goog.events.BrowserEvent} inEvent The in event. */ ol.pointer.MouseSource.prototype.mouseup = function(inEvent) { if (!this.isEventSimulatedFromTouch_(inEvent)) { @@ -206,7 +206,7 @@ ol.pointer.MouseSource.prototype.mouseup = function(inEvent) { /** * Handler for `mouseover`. * - * @param {goog.events.BrowserEvent} inEvent + * @param {goog.events.BrowserEvent} inEvent The in event. */ ol.pointer.MouseSource.prototype.mouseover = function(inEvent) { if (!this.isEventSimulatedFromTouch_(inEvent)) { @@ -219,7 +219,7 @@ ol.pointer.MouseSource.prototype.mouseover = function(inEvent) { /** * Handler for `mouseout`. * - * @param {goog.events.BrowserEvent} inEvent + * @param {goog.events.BrowserEvent} inEvent The in event. */ ol.pointer.MouseSource.prototype.mouseout = function(inEvent) { if (!this.isEventSimulatedFromTouch_(inEvent)) { @@ -232,7 +232,7 @@ ol.pointer.MouseSource.prototype.mouseout = function(inEvent) { /** * Dispatches a `pointercancel` event. * - * @param {goog.events.BrowserEvent} inEvent + * @param {goog.events.BrowserEvent} inEvent The in event. */ ol.pointer.MouseSource.prototype.cancel = function(inEvent) { var e = ol.pointer.MouseSource.prepareEvent(inEvent, this.dispatcher); diff --git a/src/ol/pointer/mssource.js b/src/ol/pointer/mssource.js index 5855758f12..75715b5ef5 100644 --- a/src/ol/pointer/mssource.js +++ b/src/ol/pointer/mssource.js @@ -35,7 +35,7 @@ goog.require('ol.pointer.EventSource'); /** - * @param {ol.pointer.PointerEventHandler} dispatcher + * @param {ol.pointer.PointerEventHandler} dispatcher Event handler. * @constructor * @extends {ol.pointer.EventSource} */ @@ -78,8 +78,8 @@ goog.inherits(ol.pointer.MsSource, ol.pointer.EventSource); * for the fake pointer event. * * @private - * @param {goog.events.BrowserEvent} inEvent - * @return {Object} + * @param {goog.events.BrowserEvent} inEvent The in event. + * @return {Object} The copied event. */ ol.pointer.MsSource.prototype.prepareEvent_ = function(inEvent) { var e = inEvent; @@ -94,7 +94,7 @@ ol.pointer.MsSource.prototype.prepareEvent_ = function(inEvent) { /** * Remove this pointer from the list of active pointers. - * @param {number} pointerId + * @param {number} pointerId Pointer identifier. */ ol.pointer.MsSource.prototype.cleanup = function(pointerId) { delete this.pointerMap[pointerId.toString()]; @@ -104,7 +104,7 @@ ol.pointer.MsSource.prototype.cleanup = function(pointerId) { /** * Handler for `msPointerDown`. * - * @param {goog.events.BrowserEvent} inEvent + * @param {goog.events.BrowserEvent} inEvent The in event. */ ol.pointer.MsSource.prototype.msPointerDown = function(inEvent) { this.pointerMap[inEvent.getBrowserEvent().pointerId.toString()] = inEvent; @@ -116,7 +116,7 @@ ol.pointer.MsSource.prototype.msPointerDown = function(inEvent) { /** * Handler for `msPointerMove`. * - * @param {goog.events.BrowserEvent} inEvent + * @param {goog.events.BrowserEvent} inEvent The in event. */ ol.pointer.MsSource.prototype.msPointerMove = function(inEvent) { var e = this.prepareEvent_(inEvent); @@ -127,7 +127,7 @@ ol.pointer.MsSource.prototype.msPointerMove = function(inEvent) { /** * Handler for `msPointerUp`. * - * @param {goog.events.BrowserEvent} inEvent + * @param {goog.events.BrowserEvent} inEvent The in event. */ ol.pointer.MsSource.prototype.msPointerUp = function(inEvent) { var e = this.prepareEvent_(inEvent); @@ -139,7 +139,7 @@ ol.pointer.MsSource.prototype.msPointerUp = function(inEvent) { /** * Handler for `msPointerOut`. * - * @param {goog.events.BrowserEvent} inEvent + * @param {goog.events.BrowserEvent} inEvent The in event. */ ol.pointer.MsSource.prototype.msPointerOut = function(inEvent) { var e = this.prepareEvent_(inEvent); @@ -150,7 +150,7 @@ ol.pointer.MsSource.prototype.msPointerOut = function(inEvent) { /** * Handler for `msPointerOver`. * - * @param {goog.events.BrowserEvent} inEvent + * @param {goog.events.BrowserEvent} inEvent The in event. */ ol.pointer.MsSource.prototype.msPointerOver = function(inEvent) { var e = this.prepareEvent_(inEvent); @@ -161,7 +161,7 @@ ol.pointer.MsSource.prototype.msPointerOver = function(inEvent) { /** * Handler for `msPointerCancel`. * - * @param {goog.events.BrowserEvent} inEvent + * @param {goog.events.BrowserEvent} inEvent The in event. */ ol.pointer.MsSource.prototype.msPointerCancel = function(inEvent) { var e = this.prepareEvent_(inEvent); @@ -173,7 +173,7 @@ ol.pointer.MsSource.prototype.msPointerCancel = function(inEvent) { /** * Handler for `msLostPointerCapture`. * - * @param {goog.events.BrowserEvent} inEvent + * @param {goog.events.BrowserEvent} inEvent The in event. */ ol.pointer.MsSource.prototype.msLostPointerCapture = function(inEvent) { var e = this.dispatcher.makeEvent('lostpointercapture', @@ -185,7 +185,7 @@ ol.pointer.MsSource.prototype.msLostPointerCapture = function(inEvent) { /** * Handler for `msGotPointerCapture`. * - * @param {goog.events.BrowserEvent} inEvent + * @param {goog.events.BrowserEvent} inEvent The in event. */ ol.pointer.MsSource.prototype.msGotPointerCapture = function(inEvent) { var e = this.dispatcher.makeEvent('gotpointercapture', diff --git a/src/ol/pointer/nativesource.js b/src/ol/pointer/nativesource.js index 8fa61c118e..4afa272ad4 100644 --- a/src/ol/pointer/nativesource.js +++ b/src/ol/pointer/nativesource.js @@ -35,7 +35,7 @@ goog.require('ol.pointer.EventSource'); /** - * @param {ol.pointer.PointerEventHandler} dispatcher + * @param {ol.pointer.PointerEventHandler} dispatcher Event handler. * @constructor * @extends {ol.pointer.EventSource} */ @@ -58,7 +58,7 @@ goog.inherits(ol.pointer.NativeSource, ol.pointer.EventSource); /** * Handler for `pointerdown`. * - * @param {goog.events.BrowserEvent} inEvent + * @param {goog.events.BrowserEvent} inEvent The in event. */ ol.pointer.NativeSource.prototype.pointerDown = function(inEvent) { this.dispatcher.fireNativeEvent(inEvent); @@ -68,7 +68,7 @@ ol.pointer.NativeSource.prototype.pointerDown = function(inEvent) { /** * Handler for `pointermove`. * - * @param {goog.events.BrowserEvent} inEvent + * @param {goog.events.BrowserEvent} inEvent The in event. */ ol.pointer.NativeSource.prototype.pointerMove = function(inEvent) { this.dispatcher.fireNativeEvent(inEvent); @@ -78,7 +78,7 @@ ol.pointer.NativeSource.prototype.pointerMove = function(inEvent) { /** * Handler for `pointerup`. * - * @param {goog.events.BrowserEvent} inEvent + * @param {goog.events.BrowserEvent} inEvent The in event. */ ol.pointer.NativeSource.prototype.pointerUp = function(inEvent) { this.dispatcher.fireNativeEvent(inEvent); @@ -88,7 +88,7 @@ ol.pointer.NativeSource.prototype.pointerUp = function(inEvent) { /** * Handler for `pointerout`. * - * @param {goog.events.BrowserEvent} inEvent + * @param {goog.events.BrowserEvent} inEvent The in event. */ ol.pointer.NativeSource.prototype.pointerOut = function(inEvent) { this.dispatcher.fireNativeEvent(inEvent); @@ -98,7 +98,7 @@ ol.pointer.NativeSource.prototype.pointerOut = function(inEvent) { /** * Handler for `pointerover`. * - * @param {goog.events.BrowserEvent} inEvent + * @param {goog.events.BrowserEvent} inEvent The in event. */ ol.pointer.NativeSource.prototype.pointerOver = function(inEvent) { this.dispatcher.fireNativeEvent(inEvent); @@ -108,7 +108,7 @@ ol.pointer.NativeSource.prototype.pointerOver = function(inEvent) { /** * Handler for `pointercancel`. * - * @param {goog.events.BrowserEvent} inEvent + * @param {goog.events.BrowserEvent} inEvent The in event. */ ol.pointer.NativeSource.prototype.pointerCancel = function(inEvent) { this.dispatcher.fireNativeEvent(inEvent); @@ -118,7 +118,7 @@ ol.pointer.NativeSource.prototype.pointerCancel = function(inEvent) { /** * Handler for `lostpointercapture`. * - * @param {goog.events.BrowserEvent} inEvent + * @param {goog.events.BrowserEvent} inEvent The in event. */ ol.pointer.NativeSource.prototype.lostPointerCapture = function(inEvent) { this.dispatcher.fireNativeEvent(inEvent); @@ -128,7 +128,7 @@ ol.pointer.NativeSource.prototype.lostPointerCapture = function(inEvent) { /** * Handler for `gotpointercapture`. * - * @param {goog.events.BrowserEvent} inEvent + * @param {goog.events.BrowserEvent} inEvent The in event. */ ol.pointer.NativeSource.prototype.gotPointerCapture = function(inEvent) { this.dispatcher.fireNativeEvent(inEvent); diff --git a/src/ol/pointer/pointerevent.js b/src/ol/pointer/pointerevent.js index dadec5e802..5ce391527a 100644 --- a/src/ol/pointer/pointerevent.js +++ b/src/ol/pointer/pointerevent.js @@ -45,7 +45,7 @@ goog.require('goog.events.Event'); * @constructor * @extends {goog.events.Event} * @param {string} type The type of the event to create. - * @param {goog.events.BrowserEvent} browserEvent + * @param {goog.events.BrowserEvent} browserEvent The event. * @param {Object.=} opt_eventDict An optional dictionary of * initial event properties. */ @@ -198,8 +198,8 @@ goog.inherits(ol.pointer.PointerEvent, goog.events.Event); /** * @private - * @param {Object.} eventDict - * @return {number} + * @param {Object.} eventDict The event dictionary. + * @return {number} Button indicator. */ ol.pointer.PointerEvent.prototype.getButtons_ = function(eventDict) { // According to the w3c spec, @@ -240,9 +240,9 @@ ol.pointer.PointerEvent.prototype.getButtons_ = function(eventDict) { /** * @private - * @param {Object.} eventDict - * @param {number} buttons - * @return {number} + * @param {Object.} eventDict The event dictionary. + * @param {number} buttons Button indicator. + * @return {number} The pressure. */ ol.pointer.PointerEvent.prototype.getPressure_ = function(eventDict, buttons) { // Spec requires that pointers without pressure specified use 0.5 for down diff --git a/src/ol/pointer/pointereventhandler.js b/src/ol/pointer/pointereventhandler.js index 2b4d299138..17352aa823 100644 --- a/src/ol/pointer/pointereventhandler.js +++ b/src/ol/pointer/pointereventhandler.js @@ -110,7 +110,7 @@ ol.pointer.PointerEventHandler.prototype.registerSources = function() { * Add a new event source that will generate pointer events. * * @param {string} name A name for the event source - * @param {ol.pointer.EventSource} source + * @param {ol.pointer.EventSource} source The source event. */ ol.pointer.PointerEventHandler.prototype.registerSource = function(name, source) { @@ -227,8 +227,8 @@ ol.pointer.PointerEventHandler.prototype.cloneEvent = /** * Triggers a 'pointerdown' event. - * @param {Object} pointerEventData - * @param {goog.events.BrowserEvent} browserEvent + * @param {Object} pointerEventData Pointer event data. + * @param {goog.events.BrowserEvent} browserEvent The event. */ ol.pointer.PointerEventHandler.prototype.down = function(pointerEventData, browserEvent) { @@ -239,8 +239,8 @@ ol.pointer.PointerEventHandler.prototype.down = /** * Triggers a 'pointermove' event. - * @param {Object} pointerEventData - * @param {goog.events.BrowserEvent} browserEvent + * @param {Object} pointerEventData Pointer event data. + * @param {goog.events.BrowserEvent} browserEvent The event. */ ol.pointer.PointerEventHandler.prototype.move = function(pointerEventData, browserEvent) { @@ -251,8 +251,8 @@ ol.pointer.PointerEventHandler.prototype.move = /** * Triggers a 'pointerup' event. - * @param {Object} pointerEventData - * @param {goog.events.BrowserEvent} browserEvent + * @param {Object} pointerEventData Pointer event data. + * @param {goog.events.BrowserEvent} browserEvent The event. */ ol.pointer.PointerEventHandler.prototype.up = function(pointerEventData, browserEvent) { @@ -263,8 +263,8 @@ ol.pointer.PointerEventHandler.prototype.up = /** * Triggers a 'pointerenter' event. - * @param {Object} pointerEventData - * @param {goog.events.BrowserEvent} browserEvent + * @param {Object} pointerEventData Pointer event data. + * @param {goog.events.BrowserEvent} browserEvent The event. */ ol.pointer.PointerEventHandler.prototype.enter = function(pointerEventData, browserEvent) { @@ -276,8 +276,8 @@ ol.pointer.PointerEventHandler.prototype.enter = /** * Triggers a 'pointerleave' event. - * @param {Object} pointerEventData - * @param {goog.events.BrowserEvent} browserEvent + * @param {Object} pointerEventData Pointer event data. + * @param {goog.events.BrowserEvent} browserEvent The event. */ ol.pointer.PointerEventHandler.prototype.leave = function(pointerEventData, browserEvent) { @@ -289,8 +289,8 @@ ol.pointer.PointerEventHandler.prototype.leave = /** * Triggers a 'pointerover' event. - * @param {Object} pointerEventData - * @param {goog.events.BrowserEvent} browserEvent + * @param {Object} pointerEventData Pointer event data. + * @param {goog.events.BrowserEvent} browserEvent The event. */ ol.pointer.PointerEventHandler.prototype.over = function(pointerEventData, browserEvent) { @@ -302,8 +302,8 @@ ol.pointer.PointerEventHandler.prototype.over = /** * Triggers a 'pointerout' event. - * @param {Object} pointerEventData - * @param {goog.events.BrowserEvent} browserEvent + * @param {Object} pointerEventData Pointer event data. + * @param {goog.events.BrowserEvent} browserEvent The event. */ ol.pointer.PointerEventHandler.prototype.out = function(pointerEventData, browserEvent) { @@ -315,8 +315,8 @@ ol.pointer.PointerEventHandler.prototype.out = /** * Triggers a 'pointercancel' event. - * @param {Object} pointerEventData - * @param {goog.events.BrowserEvent} browserEvent + * @param {Object} pointerEventData Pointer event data. + * @param {goog.events.BrowserEvent} browserEvent The event. */ ol.pointer.PointerEventHandler.prototype.cancel = function(pointerEventData, browserEvent) { @@ -327,8 +327,8 @@ ol.pointer.PointerEventHandler.prototype.cancel = /** * Triggers a combination of 'pointerout' and 'pointerleave' events. - * @param {Object} pointerEventData - * @param {goog.events.BrowserEvent} browserEvent + * @param {Object} pointerEventData Pointer event data. + * @param {goog.events.BrowserEvent} browserEvent The event. */ ol.pointer.PointerEventHandler.prototype.leaveOut = function(pointerEventData, browserEvent) { @@ -343,8 +343,8 @@ ol.pointer.PointerEventHandler.prototype.leaveOut = /** * Triggers a combination of 'pointerover' and 'pointerevents' events. - * @param {Object} pointerEventData - * @param {goog.events.BrowserEvent} browserEvent + * @param {Object} pointerEventData Pointer event data. + * @param {goog.events.BrowserEvent} browserEvent The event. */ ol.pointer.PointerEventHandler.prototype.enterOver = function(pointerEventData, browserEvent) { @@ -359,8 +359,8 @@ ol.pointer.PointerEventHandler.prototype.enterOver = /** * @private - * @param {Element} container - * @param {Element} contained + * @param {Element} container The container element. + * @param {Element} contained The contained element. * @return {boolean} Returns true if the container element * contains the other element. */ @@ -379,8 +379,8 @@ ol.pointer.PointerEventHandler.prototype.contains_ = * `pointerEventData`. * * @param {string} inType A string representing the type of event to create. - * @param {Object} pointerEventData - * @param {goog.events.BrowserEvent} browserEvent + * @param {Object} pointerEventData Pointer event data. + * @param {goog.events.BrowserEvent} browserEvent The event. * @return {ol.pointer.PointerEvent} A PointerEvent of type `inType`. */ ol.pointer.PointerEventHandler.prototype.makeEvent = @@ -392,8 +392,8 @@ ol.pointer.PointerEventHandler.prototype.makeEvent = /** * Make and dispatch an event in one call. * @param {string} inType A string representing the type of event. - * @param {Object} pointerEventData - * @param {goog.events.BrowserEvent} browserEvent + * @param {Object} pointerEventData Pointer event data. + * @param {goog.events.BrowserEvent} browserEvent The event. */ ol.pointer.PointerEventHandler.prototype.fireEvent = function(inType, pointerEventData, browserEvent) { @@ -419,8 +419,8 @@ ol.pointer.PointerEventHandler.prototype.fireNativeEvent = * Wrap a native mouse event into a pointer event. * This proxy method is required for the legacy IE support. * @param {string} eventType The pointer event type. - * @param {goog.events.BrowserEvent} browserEvent - * @return {ol.pointer.PointerEvent} + * @param {goog.events.BrowserEvent} browserEvent The event. + * @return {ol.pointer.PointerEvent} The wrapped event. */ ol.pointer.PointerEventHandler.prototype.wrapMouseEvent = function(eventType, browserEvent) { diff --git a/src/ol/pointer/touchsource.js b/src/ol/pointer/touchsource.js index b400b9e733..cf787c45cb 100644 --- a/src/ol/pointer/touchsource.js +++ b/src/ol/pointer/touchsource.js @@ -179,7 +179,7 @@ ol.pointer.TouchSource.prototype.cancelResetClickCount_ = function() { * @private * @param {goog.events.BrowserEvent} browserEvent Browser event * @param {Touch} inTouch Touch event - * @return {Object} + * @return {Object} A pointer object. */ ol.pointer.TouchSource.prototype.touchToPointer_ = function(browserEvent, inTouch) { @@ -215,7 +215,7 @@ ol.pointer.TouchSource.prototype.touchToPointer_ = /** * @private * @param {goog.events.BrowserEvent} inEvent Touch event - * @param {function(goog.events.BrowserEvent, Object)} inFunction + * @param {function(goog.events.BrowserEvent, Object)} inFunction In function. */ ol.pointer.TouchSource.prototype.processTouches_ = function(inEvent, inFunction) { @@ -337,8 +337,8 @@ ol.pointer.TouchSource.prototype.touchmove = function(inEvent) { /** * @private - * @param {goog.events.BrowserEvent} browserEvent - * @param {Object} inPointer + * @param {goog.events.BrowserEvent} browserEvent The event. + * @param {Object} inPointer The in pointer. */ ol.pointer.TouchSource.prototype.moveOverOut_ = function(browserEvent, inPointer) { @@ -409,8 +409,8 @@ ol.pointer.TouchSource.prototype.touchcancel = function(inEvent) { /** * @private - * @param {goog.events.BrowserEvent} browserEvent - * @param {Object} inPointer + * @param {goog.events.BrowserEvent} browserEvent The event. + * @param {Object} inPointer The in pointer. */ ol.pointer.TouchSource.prototype.cancelOut_ = function(browserEvent, inPointer) { diff --git a/src/ol/renderer/canvas/canvaslayerrenderer.js b/src/ol/renderer/canvas/canvaslayerrenderer.js index 749297a6ca..a0da527720 100644 --- a/src/ol/renderer/canvas/canvaslayerrenderer.js +++ b/src/ol/renderer/canvas/canvaslayerrenderer.js @@ -223,7 +223,7 @@ ol.renderer.canvas.Layer.prototype.prepareFrame = goog.abstractMethod; * @param {ol.Pixel} pixelOnMap Pixel. * @param {goog.vec.Mat4.Number} imageTransformInv The transformation matrix * to convert from a map pixel to a canvas pixel. - * @return {ol.Pixel} + * @return {ol.Pixel} The pixel. * @protected */ ol.renderer.canvas.Layer.prototype.getPixelOnCanvas = diff --git a/src/ol/renderer/webgl/webglimagelayerrenderer.js b/src/ol/renderer/webgl/webglimagelayerrenderer.js index dc8d7cc51d..0aca1abc2b 100644 --- a/src/ol/renderer/webgl/webglimagelayerrenderer.js +++ b/src/ol/renderer/webgl/webglimagelayerrenderer.js @@ -294,9 +294,9 @@ ol.renderer.webgl.ImageLayer.prototype.forEachLayerAtPixel = /** * The transformation matrix to get the pixel on the image for a * pixel on the map. - * @param {ol.Size} mapSize - * @param {ol.Size} imageSize - * @return {goog.vec.Mat4.Number} + * @param {ol.Size} mapSize The map size. + * @param {ol.Size} imageSize The image size. + * @return {goog.vec.Mat4.Number} The transformation matrix. * @private */ ol.renderer.webgl.ImageLayer.prototype.getHitTransformationMatrix_ = diff --git a/src/ol/style/circlestyle.js b/src/ol/style/circlestyle.js index be1d0c06b9..e3819b602b 100644 --- a/src/ol/style/circlestyle.js +++ b/src/ol/style/circlestyle.js @@ -384,8 +384,8 @@ ol.style.Circle.prototype.createHitDetectionCanvas_ = function(renderOptions) { /** * @private - * @param {ol.style.Circle.RenderOptions} renderOptions - * @param {CanvasRenderingContext2D} context + * @param {ol.style.Circle.RenderOptions} renderOptions Render options. + * @param {CanvasRenderingContext2D} context The context. * @param {number} x The origin for the symbol (x). * @param {number} y The origin for the symbol (y). */ diff --git a/src/ol/style/regularshapestyle.js b/src/ol/style/regularshapestyle.js index 9a88658198..1a89113fa3 100644 --- a/src/ol/style/regularshapestyle.js +++ b/src/ol/style/regularshapestyle.js @@ -448,7 +448,7 @@ ol.style.RegularShape.prototype.draw_ = function(renderOptions, context, x, y) { /** * @private - * @param {ol.style.RegularShape.RenderOptions} renderOptions + * @param {ol.style.RegularShape.RenderOptions} renderOptions Render options. */ ol.style.RegularShape.prototype.createHitDetectionCanvas_ = function(renderOptions) { @@ -475,8 +475,8 @@ ol.style.RegularShape.prototype.createHitDetectionCanvas_ = /** * @private - * @param {ol.style.RegularShape.RenderOptions} renderOptions - * @param {CanvasRenderingContext2D} context + * @param {ol.style.RegularShape.RenderOptions} renderOptions Render options. + * @param {CanvasRenderingContext2D} context The context. * @param {number} x The origin for the symbol (x). * @param {number} y The origin for the symbol (y). */