From d59224f5eb718c68a7bcc31f4aa8dcf9aac00caf Mon Sep 17 00:00:00 2001 From: Frederic Junod Date: Fri, 16 Dec 2016 15:49:53 +0100 Subject: [PATCH] Add missing override and inheritDoc jsdoc tags --- src/ol/control/control.js | 1 + src/ol/events/event.js | 2 ++ src/ol/format/esrijson.js | 3 +++ src/ol/format/geojson.js | 4 ++++ src/ol/format/gml3.js | 2 ++ src/ol/format/gpx.js | 1 + src/ol/format/kml.js | 1 + src/ol/format/ows.js | 6 ++---- src/ol/format/topojson.js | 2 +- src/ol/format/wmscapabilities.js | 6 ++---- src/ol/format/wmtscapabilities.js | 6 ++---- src/ol/geom/circle.js | 1 + src/ol/geom/geometrycollection.js | 2 ++ src/ol/geom/linearring.js | 3 +++ src/ol/geom/linestring.js | 3 +++ src/ol/geom/multilinestring.js | 3 +++ src/ol/geom/multipoint.js | 3 +++ src/ol/geom/multipolygon.js | 3 +++ src/ol/geom/point.js | 6 +++--- src/ol/geom/polygon.js | 3 +++ src/ol/image.js | 5 ++--- src/ol/imagecanvas.js | 2 +- src/ol/imagetile.js | 4 +--- src/ol/interaction/select.js | 1 + src/ol/render/canvas/immediate.js | 14 ++++++++++++++ src/ol/render/vectorcontext.js | 2 +- src/ol/render/webgl/immediate.js | 2 ++ src/ol/renderer/webgl/tilelayer.js | 10 +--------- src/ol/source/image.js | 1 + src/ol/source/tiledebug.js | 1 + src/ol/source/tileutfgrid.js | 3 ++- src/ol/style/circle.js | 1 + src/ol/style/icon.js | 5 +++-- src/ol/vectortile.js | 2 +- 34 files changed, 77 insertions(+), 37 deletions(-) diff --git a/src/ol/control/control.js b/src/ol/control/control.js index eaaefbfc7f..8f7ffb176b 100644 --- a/src/ol/control/control.js +++ b/src/ol/control/control.js @@ -101,6 +101,7 @@ ol.control.Control.prototype.getMap = function() { * Subclasses may set up event handlers to get notified about changes to * the map here. * @param {ol.Map} map Map. + * @override * @api stable */ ol.control.Control.prototype.setMap = function(map) { diff --git a/src/ol/events/event.js b/src/ol/events/event.js index 90301d236b..6b571364f9 100644 --- a/src/ol/events/event.js +++ b/src/ol/events/event.js @@ -42,6 +42,7 @@ ol.events.Event = function(type) { /** * Stop event propagation. * @function + * @override * @api stable */ ol.events.Event.prototype.preventDefault = @@ -49,6 +50,7 @@ ol.events.Event.prototype.preventDefault = /** * Stop event propagation. * @function + * @override * @api stable */ ol.events.Event.prototype.stopPropagation = function() { diff --git a/src/ol/format/esrijson.js b/src/ol/format/esrijson.js index a304cacec9..ce0e5e6d1a 100644 --- a/src/ol/format/esrijson.js +++ b/src/ol/format/esrijson.js @@ -582,6 +582,7 @@ ol.format.EsriJSON.prototype.writeGeometry; * @param {ol.geom.Geometry} geometry Geometry. * @param {olx.format.WriteOptions=} opt_options Write options. * @return {EsriJSONGeometry} Object. + * @override * @api */ ol.format.EsriJSON.prototype.writeGeometryObject = function(geometry, @@ -609,6 +610,7 @@ ol.format.EsriJSON.prototype.writeFeature; * @param {ol.Feature} feature Feature. * @param {olx.format.WriteOptions=} opt_options Write options. * @return {Object} Object. + * @override * @api */ ol.format.EsriJSON.prototype.writeFeatureObject = function( @@ -655,6 +657,7 @@ ol.format.EsriJSON.prototype.writeFeatures; * @param {Array.} features Features. * @param {olx.format.WriteOptions=} opt_options Write options. * @return {Object} EsriJSON Object. + * @override * @api */ ol.format.EsriJSON.prototype.writeFeaturesObject = function(features, opt_options) { diff --git a/src/ol/format/geojson.js b/src/ol/format/geojson.js index f93175eb6d..172814154b 100644 --- a/src/ol/format/geojson.js +++ b/src/ol/format/geojson.js @@ -479,6 +479,7 @@ ol.format.GeoJSON.prototype.readProjectionFromObject = function(object) { * @param {ol.Feature} feature Feature. * @param {olx.format.WriteOptions=} opt_options Write options. * @return {string} GeoJSON. + * @override * @api stable */ ol.format.GeoJSON.prototype.writeFeature; @@ -490,6 +491,7 @@ ol.format.GeoJSON.prototype.writeFeature; * @param {ol.Feature} feature Feature. * @param {olx.format.WriteOptions=} opt_options Write options. * @return {GeoJSONFeature} Object. + * @override * @api stable */ ol.format.GeoJSON.prototype.writeFeatureObject = function(feature, opt_options) { @@ -538,6 +540,7 @@ ol.format.GeoJSON.prototype.writeFeatures; * @param {Array.} features Features. * @param {olx.format.WriteOptions=} opt_options Write options. * @return {GeoJSONFeatureCollection} GeoJSON Object. + * @override * @api stable */ ol.format.GeoJSON.prototype.writeFeaturesObject = function(features, opt_options) { @@ -572,6 +575,7 @@ ol.format.GeoJSON.prototype.writeGeometry; * @param {ol.geom.Geometry} geometry Geometry. * @param {olx.format.WriteOptions=} opt_options Write options. * @return {GeoJSONGeometry|GeoJSONGeometryCollection} Object. + * @override * @api stable */ ol.format.GeoJSON.prototype.writeGeometryObject = function(geometry, diff --git a/src/ol/format/gml3.js b/src/ol/format/gml3.js index 01e745d6c8..531ef3fccf 100644 --- a/src/ol/format/gml3.js +++ b/src/ol/format/gml3.js @@ -1162,6 +1162,7 @@ ol.format.GML3.prototype.GEOMETRY_NODE_FACTORY_ = function(value, objectStack, o * @param {ol.geom.Geometry} geometry Geometry. * @param {olx.format.WriteOptions=} opt_options Options. * @return {Node} Node. + * @override * @api */ ol.format.GML3.prototype.writeGeometryNode = function(geometry, opt_options) { @@ -1196,6 +1197,7 @@ ol.format.GML3.prototype.writeFeatures; * @param {Array.} features Features. * @param {olx.format.WriteOptions=} opt_options Options. * @return {Node} Node. + * @override * @api */ ol.format.GML3.prototype.writeFeaturesNode = function(features, opt_options) { diff --git a/src/ol/format/gpx.js b/src/ol/format/gpx.js index b7b1340607..cbca26a1b4 100644 --- a/src/ol/format/gpx.js +++ b/src/ol/format/gpx.js @@ -926,6 +926,7 @@ ol.format.GPX.prototype.writeFeatures; * @param {Array.} features Features. * @param {olx.format.WriteOptions=} opt_options Options. * @return {Node} Node. + * @override * @api */ ol.format.GPX.prototype.writeFeaturesNode = function(features, opt_options) { diff --git a/src/ol/format/kml.js b/src/ol/format/kml.js index 49583d6075..3107de95e8 100644 --- a/src/ol/format/kml.js +++ b/src/ol/format/kml.js @@ -3018,6 +3018,7 @@ ol.format.KML.prototype.writeFeatures; * @param {Array.} features Features. * @param {olx.format.WriteOptions=} opt_options Options. * @return {Node} Node. + * @override * @api */ ol.format.KML.prototype.writeFeaturesNode = function(features, opt_options) { diff --git a/src/ol/format/ows.js b/src/ol/format/ows.js index 3f9b079df3..3ed2be4e83 100644 --- a/src/ol/format/ows.js +++ b/src/ol/format/ows.js @@ -18,8 +18,7 @@ ol.inherits(ol.format.OWS, ol.format.XML); /** - * @param {Document} doc Document. - * @return {Object} OWS object. + * @inheritDoc */ ol.format.OWS.prototype.readFromDocument = function(doc) { for (var n = doc.firstChild; n; n = n.nextSibling) { @@ -32,8 +31,7 @@ ol.format.OWS.prototype.readFromDocument = function(doc) { /** - * @param {Node} node Node. - * @return {Object} OWS object. + * @inheritDoc */ ol.format.OWS.prototype.readFromNode = function(node) { var owsObject = ol.xml.pushParseAndPop({}, diff --git a/src/ol/format/topojson.js b/src/ol/format/topojson.js index c0c4a5b263..c7244dd5f4 100644 --- a/src/ol/format/topojson.js +++ b/src/ol/format/topojson.js @@ -366,9 +366,9 @@ ol.format.TopoJSON.transformVertex_ = function(vertex, scale, translate) { /** * Read the projection from a TopoJSON source. * - * @function * @param {Document|Node|Object|string} object Source. * @return {ol.proj.Projection} Projection. + * @override * @api stable */ ol.format.TopoJSON.prototype.readProjection = function(object) { diff --git a/src/ol/format/wmscapabilities.js b/src/ol/format/wmscapabilities.js index 5f39a3861b..e7607ee62f 100644 --- a/src/ol/format/wmscapabilities.js +++ b/src/ol/format/wmscapabilities.js @@ -39,8 +39,7 @@ ol.format.WMSCapabilities.prototype.read; /** - * @param {Document} doc Document. - * @return {Object} WMS Capability object. + * @inheritDoc */ ol.format.WMSCapabilities.prototype.readFromDocument = function(doc) { for (var n = doc.firstChild; n; n = n.nextSibling) { @@ -53,8 +52,7 @@ ol.format.WMSCapabilities.prototype.readFromDocument = function(doc) { /** - * @param {Node} node Node. - * @return {Object} WMS Capability object. + * @inheritDoc */ ol.format.WMSCapabilities.prototype.readFromNode = function(node) { this.version = node.getAttribute('version').trim(); diff --git a/src/ol/format/wmtscapabilities.js b/src/ol/format/wmtscapabilities.js index 12fb18f611..02d2c32fda 100644 --- a/src/ol/format/wmtscapabilities.js +++ b/src/ol/format/wmtscapabilities.js @@ -41,8 +41,7 @@ ol.format.WMTSCapabilities.prototype.read; /** - * @param {Document} doc Document. - * @return {Object} WMTS Capability object. + * @inheritDoc */ ol.format.WMTSCapabilities.prototype.readFromDocument = function(doc) { for (var n = doc.firstChild; n; n = n.nextSibling) { @@ -55,8 +54,7 @@ ol.format.WMTSCapabilities.prototype.readFromDocument = function(doc) { /** - * @param {Node} node Node. - * @return {Object} WMTS Capability object. + * @inheritDoc */ ol.format.WMTSCapabilities.prototype.readFromNode = function(node) { var version = node.getAttribute('version').trim(); diff --git a/src/ol/geom/circle.js b/src/ol/geom/circle.js index f199cc9018..75c73dbb69 100644 --- a/src/ol/geom/circle.js +++ b/src/ol/geom/circle.js @@ -30,6 +30,7 @@ ol.inherits(ol.geom.Circle, ol.geom.SimpleGeometry); /** * Make a complete copy of the geometry. * @return {!ol.geom.Circle} Clone. + * @override * @api */ ol.geom.Circle.prototype.clone = function() { diff --git a/src/ol/geom/geometrycollection.js b/src/ol/geom/geometrycollection.js index c43a40d08d..23f960ab54 100644 --- a/src/ol/geom/geometrycollection.js +++ b/src/ol/geom/geometrycollection.js @@ -83,6 +83,7 @@ ol.geom.GeometryCollection.prototype.listenGeometriesChange_ = function() { /** * Make a complete copy of the geometry. * @return {!ol.geom.GeometryCollection} Clone. + * @override * @api stable */ ol.geom.GeometryCollection.prototype.clone = function() { @@ -302,6 +303,7 @@ ol.geom.GeometryCollection.prototype.applyTransform = function(transformFn) { * Translate the geometry. * @param {number} deltaX Delta X. * @param {number} deltaY Delta Y. + * @override * @api */ ol.geom.GeometryCollection.prototype.translate = function(deltaX, deltaY) { diff --git a/src/ol/geom/linearring.js b/src/ol/geom/linearring.js index a4ebdf1559..419c2eb8d0 100644 --- a/src/ol/geom/linearring.js +++ b/src/ol/geom/linearring.js @@ -48,6 +48,7 @@ ol.inherits(ol.geom.LinearRing, ol.geom.SimpleGeometry); /** * Make a complete copy of the geometry. * @return {!ol.geom.LinearRing} Clone. + * @override * @api stable */ ol.geom.LinearRing.prototype.clone = function() { @@ -90,6 +91,7 @@ ol.geom.LinearRing.prototype.getArea = function() { /** * Return the coordinates of the linear ring. * @return {Array.} Coordinates. + * @override * @api stable */ ol.geom.LinearRing.prototype.getCoordinates = function() { @@ -126,6 +128,7 @@ ol.geom.LinearRing.prototype.getType = function() { * Set the coordinates of the linear ring. * @param {Array.} coordinates Coordinates. * @param {ol.geom.GeometryLayout=} opt_layout Layout. + * @override * @api stable */ ol.geom.LinearRing.prototype.setCoordinates = function(coordinates, opt_layout) { diff --git a/src/ol/geom/linestring.js b/src/ol/geom/linestring.js index dff2d47d6d..dd13803d5d 100644 --- a/src/ol/geom/linestring.js +++ b/src/ol/geom/linestring.js @@ -78,6 +78,7 @@ ol.geom.LineString.prototype.appendCoordinate = function(coordinate) { /** * Make a complete copy of the geometry. * @return {!ol.geom.LineString} Clone. + * @override * @api stable */ ol.geom.LineString.prototype.clone = function() { @@ -153,6 +154,7 @@ ol.geom.LineString.prototype.getCoordinateAtM = function(m, opt_extrapolate) { /** * Return the coordinates of the linestring. * @return {Array.} Coordinates. + * @override * @api stable */ ol.geom.LineString.prototype.getCoordinates = function() { @@ -240,6 +242,7 @@ ol.geom.LineString.prototype.intersectsExtent = function(extent) { * Set the coordinates of the linestring. * @param {Array.} coordinates Coordinates. * @param {ol.geom.GeometryLayout=} opt_layout Layout. + * @override * @api stable */ ol.geom.LineString.prototype.setCoordinates = function(coordinates, opt_layout) { diff --git a/src/ol/geom/multilinestring.js b/src/ol/geom/multilinestring.js index 14377c9255..c5d15bb9f1 100644 --- a/src/ol/geom/multilinestring.js +++ b/src/ol/geom/multilinestring.js @@ -73,6 +73,7 @@ ol.geom.MultiLineString.prototype.appendLineString = function(lineString) { /** * Make a complete copy of the geometry. * @return {!ol.geom.MultiLineString} Clone. + * @override * @api stable */ ol.geom.MultiLineString.prototype.clone = function() { @@ -140,6 +141,7 @@ ol.geom.MultiLineString.prototype.getCoordinateAtM = function(m, opt_extrapolate /** * Return the coordinates of the multilinestring. * @return {Array.>} Coordinates. + * @override * @api stable */ ol.geom.MultiLineString.prototype.getCoordinates = function() { @@ -257,6 +259,7 @@ ol.geom.MultiLineString.prototype.intersectsExtent = function(extent) { * Set the coordinates of the multilinestring. * @param {Array.>} coordinates Coordinates. * @param {ol.geom.GeometryLayout=} opt_layout Layout. + * @override * @api stable */ ol.geom.MultiLineString.prototype.setCoordinates = function(coordinates, opt_layout) { diff --git a/src/ol/geom/multipoint.js b/src/ol/geom/multipoint.js index 35f67bf8bb..8a8c3d3c80 100644 --- a/src/ol/geom/multipoint.js +++ b/src/ol/geom/multipoint.js @@ -47,6 +47,7 @@ ol.geom.MultiPoint.prototype.appendPoint = function(point) { /** * Make a complete copy of the geometry. * @return {!ol.geom.MultiPoint} Clone. + * @override * @api stable */ ol.geom.MultiPoint.prototype.clone = function() { @@ -85,6 +86,7 @@ ol.geom.MultiPoint.prototype.closestPointXY = function(x, y, closestPoint, minSq /** * Return the coordinates of the multipoint. * @return {Array.} Coordinates. + * @override * @api stable */ ol.geom.MultiPoint.prototype.getCoordinates = function() { @@ -165,6 +167,7 @@ ol.geom.MultiPoint.prototype.intersectsExtent = function(extent) { * Set the coordinates of the multipoint. * @param {Array.} coordinates Coordinates. * @param {ol.geom.GeometryLayout=} opt_layout Layout. + * @override * @api stable */ ol.geom.MultiPoint.prototype.setCoordinates = function(coordinates, opt_layout) { diff --git a/src/ol/geom/multipolygon.js b/src/ol/geom/multipolygon.js index e7b2b5cf44..2f1a0fc4e7 100644 --- a/src/ol/geom/multipolygon.js +++ b/src/ol/geom/multipolygon.js @@ -111,6 +111,7 @@ ol.geom.MultiPolygon.prototype.appendPolygon = function(polygon) { /** * Make a complete copy of the geometry. * @return {!ol.geom.MultiPolygon} Clone. + * @override * @api stable */ ol.geom.MultiPolygon.prototype.clone = function() { @@ -178,6 +179,7 @@ ol.geom.MultiPolygon.prototype.getArea = function() { * By default, coordinate orientation will depend on how the geometry was * constructed. * @return {Array.>>} Coordinates. + * @override * @api stable */ ol.geom.MultiPolygon.prototype.getCoordinates = function(opt_right) { @@ -355,6 +357,7 @@ ol.geom.MultiPolygon.prototype.intersectsExtent = function(extent) { * Set the coordinates of the multipolygon. * @param {Array.>>} coordinates Coordinates. * @param {ol.geom.GeometryLayout=} opt_layout Layout. + * @override * @api stable */ ol.geom.MultiPolygon.prototype.setCoordinates = function(coordinates, opt_layout) { diff --git a/src/ol/geom/point.js b/src/ol/geom/point.js index 785f053e9f..21f5de6bc6 100644 --- a/src/ol/geom/point.js +++ b/src/ol/geom/point.js @@ -29,6 +29,7 @@ ol.inherits(ol.geom.Point, ol.geom.SimpleGeometry); /** * Make a complete copy of the geometry. * @return {!ol.geom.Point} Clone. + * @override * @api stable */ ol.geom.Point.prototype.clone = function() { @@ -62,6 +63,7 @@ ol.geom.Point.prototype.closestPointXY = function(x, y, closestPoint, minSquared /** * Return the coordinate of the point. * @return {ol.Coordinate} Coordinates. + * @override * @api stable */ ol.geom.Point.prototype.getCoordinates = function() { @@ -97,9 +99,7 @@ ol.geom.Point.prototype.intersectsExtent = function(extent) { /** - * Set the coordinate of the point. - * @param {ol.Coordinate} coordinates Coordinates. - * @param {ol.geom.GeometryLayout=} opt_layout Layout. + * @inheritDoc * @api stable */ ol.geom.Point.prototype.setCoordinates = function(coordinates, opt_layout) { diff --git a/src/ol/geom/polygon.js b/src/ol/geom/polygon.js index a698534473..54816501cb 100644 --- a/src/ol/geom/polygon.js +++ b/src/ol/geom/polygon.js @@ -106,6 +106,7 @@ ol.geom.Polygon.prototype.appendLinearRing = function(linearRing) { /** * Make a complete copy of the geometry. * @return {!ol.geom.Polygon} Clone. + * @override * @api stable */ ol.geom.Polygon.prototype.clone = function() { @@ -166,6 +167,7 @@ ol.geom.Polygon.prototype.getArea = function() { * By default, coordinate orientation will depend on how the geometry was * constructed. * @return {Array.>} Coordinates. + * @override * @api stable */ ol.geom.Polygon.prototype.getCoordinates = function(opt_right) { @@ -333,6 +335,7 @@ ol.geom.Polygon.prototype.intersectsExtent = function(extent) { * Set the coordinates of the polygon. * @param {Array.>} coordinates Coordinates. * @param {ol.geom.GeometryLayout=} opt_layout Layout. + * @override * @api stable */ ol.geom.Polygon.prototype.setCoordinates = function(coordinates, opt_layout) { diff --git a/src/ol/image.js b/src/ol/image.js index c4128103a3..e9eb53f848 100644 --- a/src/ol/image.js +++ b/src/ol/image.js @@ -70,9 +70,7 @@ ol.inherits(ol.Image, ol.ImageBase); /** - * Get the HTML image element (may be a Canvas, Image, or Video). - * @param {Object=} opt_context Object. - * @return {HTMLCanvasElement|Image|HTMLVideoElement} Image. + * @inheritDoc * @api */ ol.Image.prototype.getImage = function(opt_context) { @@ -125,6 +123,7 @@ ol.Image.prototype.handleImageLoad_ = function() { * Load the image or retry if loading previously failed. * Loading is taken care of by the tile queue, and calling this method is * only needed for preloading or for reloading in case of an error. + * @override * @api */ ol.Image.prototype.load = function() { diff --git a/src/ol/imagecanvas.js b/src/ol/imagecanvas.js index 13b9e5e017..6d5d25985c 100644 --- a/src/ol/imagecanvas.js +++ b/src/ol/imagecanvas.js @@ -73,7 +73,7 @@ ol.ImageCanvas.prototype.handleLoad_ = function(err) { /** - * Trigger drawing on canvas. + * @inheritDoc */ ol.ImageCanvas.prototype.load = function() { if (this.state == ol.ImageState.IDLE) { diff --git a/src/ol/imagetile.js b/src/ol/imagetile.js index a32e29a5db..c10af92364 100644 --- a/src/ol/imagetile.js +++ b/src/ol/imagetile.js @@ -116,9 +116,7 @@ ol.ImageTile.prototype.handleImageLoad_ = function() { /** - * Load the image or retry if loading previously failed. - * Loading is taken care of by the tile queue, and calling this method is - * only needed for preloading or for reloading in case of an error. + * @inheritDoc * @api */ ol.ImageTile.prototype.load = function() { diff --git a/src/ol/interaction/select.js b/src/ol/interaction/select.js index 0be3c9361a..6f37891de3 100644 --- a/src/ol/interaction/select.js +++ b/src/ol/interaction/select.js @@ -303,6 +303,7 @@ ol.interaction.Select.prototype.setHitTolerance = function(hitTolerance) { * Remove the interaction from its current map, if any, and attach it to a new * map, if any. Pass `null` to just remove the interaction from the current map. * @param {ol.Map} map Map. + * @override * @api stable */ ol.interaction.Select.prototype.setMap = function(map) { diff --git a/src/ol/render/canvas/immediate.js b/src/ol/render/canvas/immediate.js index 757b24bce5..29abefcbfa 100644 --- a/src/ol/render/canvas/immediate.js +++ b/src/ol/render/canvas/immediate.js @@ -397,6 +397,7 @@ ol.render.canvas.Immediate.prototype.drawRings_ = function(flatCoordinates, offs * the current fill and stroke styles. * * @param {ol.geom.Circle} geometry Circle geometry. + * @override * @api */ ol.render.canvas.Immediate.prototype.drawCircle = function(geometry) { @@ -437,6 +438,7 @@ ol.render.canvas.Immediate.prototype.drawCircle = function(geometry) { * any `zIndex` on the provided style will be ignored. * * @param {ol.style.Style} style The rendering style. + * @override * @api */ ol.render.canvas.Immediate.prototype.setStyle = function(style) { @@ -451,6 +453,7 @@ ol.render.canvas.Immediate.prototype.setStyle = function(style) { * {@link ol.render.canvas.Immediate#setStyle} first to set the rendering style. * * @param {ol.geom.Geometry|ol.render.Feature} geometry The geometry to render. + * @override * @api */ ol.render.canvas.Immediate.prototype.drawGeometry = function(geometry) { @@ -493,6 +496,7 @@ ol.render.canvas.Immediate.prototype.drawGeometry = function(geometry) { * * @param {ol.Feature} feature Feature. * @param {ol.style.Style} style Style. + * @override * @api */ ol.render.canvas.Immediate.prototype.drawFeature = function(feature, style) { @@ -511,6 +515,7 @@ ol.render.canvas.Immediate.prototype.drawFeature = function(feature, style) { * uses the current styles appropriate for each geometry in the collection. * * @param {ol.geom.GeometryCollection} geometry Geometry collection. + * @override */ ol.render.canvas.Immediate.prototype.drawGeometryCollection = function(geometry) { var geometries = geometry.getGeometriesArray(); @@ -526,6 +531,7 @@ ol.render.canvas.Immediate.prototype.drawGeometryCollection = function(geometry) * the current style. * * @param {ol.geom.Point|ol.render.Feature} geometry Point geometry. + * @override */ ol.render.canvas.Immediate.prototype.drawPoint = function(geometry) { var flatCoordinates = geometry.getFlatCoordinates(); @@ -544,6 +550,7 @@ ol.render.canvas.Immediate.prototype.drawPoint = function(geometry) { * uses the current style. * * @param {ol.geom.MultiPoint|ol.render.Feature} geometry MultiPoint geometry. + * @override */ ol.render.canvas.Immediate.prototype.drawMultiPoint = function(geometry) { var flatCoordinates = geometry.getFlatCoordinates(); @@ -562,6 +569,7 @@ ol.render.canvas.Immediate.prototype.drawMultiPoint = function(geometry) { * the current style. * * @param {ol.geom.LineString|ol.render.Feature} geometry LineString geometry. + * @override */ ol.render.canvas.Immediate.prototype.drawLineString = function(geometry) { if (!ol.extent.intersects(this.extent_, geometry.getExtent())) { @@ -589,6 +597,7 @@ ol.render.canvas.Immediate.prototype.drawLineString = function(geometry) { * * @param {ol.geom.MultiLineString|ol.render.Feature} geometry MultiLineString * geometry. + * @override */ ol.render.canvas.Immediate.prototype.drawMultiLineString = function(geometry) { var geometryExtent = geometry.getExtent(); @@ -622,6 +631,7 @@ ol.render.canvas.Immediate.prototype.drawMultiLineString = function(geometry) { * the current style. * * @param {ol.geom.Polygon|ol.render.Feature} geometry Polygon geometry. + * @override */ ol.render.canvas.Immediate.prototype.drawPolygon = function(geometry) { if (!ol.extent.intersects(this.extent_, geometry.getExtent())) { @@ -656,6 +666,7 @@ ol.render.canvas.Immediate.prototype.drawPolygon = function(geometry) { * Render MultiPolygon geometry into the canvas. Rendering is immediate and * uses the current style. * @param {ol.geom.MultiPolygon} geometry MultiPolygon geometry. + * @override */ ol.render.canvas.Immediate.prototype.drawMultiPolygon = function(geometry) { if (!ol.extent.intersects(this.extent_, geometry.getExtent())) { @@ -802,6 +813,7 @@ ol.render.canvas.Immediate.prototype.setContextTextState_ = function(textState) * * @param {ol.style.Fill} fillStyle Fill style. * @param {ol.style.Stroke} strokeStyle Stroke style. + * @override */ ol.render.canvas.Immediate.prototype.setFillStrokeStyle = function(fillStyle, strokeStyle) { if (!fillStyle) { @@ -848,6 +860,7 @@ ol.render.canvas.Immediate.prototype.setFillStrokeStyle = function(fillStyle, st * the image style. * * @param {ol.style.Image} imageStyle Image style. + * @override */ ol.render.canvas.Immediate.prototype.setImageStyle = function(imageStyle) { if (!imageStyle) { @@ -879,6 +892,7 @@ ol.render.canvas.Immediate.prototype.setImageStyle = function(imageStyle) { * remove the text style. * * @param {ol.style.Text} textStyle Text style. + * @override */ ol.render.canvas.Immediate.prototype.setTextStyle = function(textStyle) { if (!textStyle) { diff --git a/src/ol/render/vectorcontext.js b/src/ol/render/vectorcontext.js index 9e76c6ba33..5f2db7cf08 100644 --- a/src/ol/render/vectorcontext.js +++ b/src/ol/render/vectorcontext.js @@ -34,7 +34,7 @@ ol.render.VectorContext.prototype.setStyle = function(style) {}; /** * @abstract * @param {ol.geom.Circle} circleGeometry Circle geometry. - * @param {ol.Feature} feature Feature, + * @param {ol.Feature} feature Feature. */ ol.render.VectorContext.prototype.drawCircle = function(circleGeometry, feature) {}; diff --git a/src/ol/render/webgl/immediate.js b/src/ol/render/webgl/immediate.js index 74f4420b18..750cb966c6 100644 --- a/src/ol/render/webgl/immediate.js +++ b/src/ol/render/webgl/immediate.js @@ -88,6 +88,7 @@ if (ol.ENABLE_WEBGL) { * any `zIndex` on the provided style will be ignored. * * @param {ol.style.Style} style The rendering style. + * @override * @api */ ol.render.webgl.Immediate.prototype.setStyle = function(style) { @@ -101,6 +102,7 @@ if (ol.ENABLE_WEBGL) { * {@link ol.render.webgl.Immediate#setStyle} first to set the rendering style. * * @param {ol.geom.Geometry|ol.render.Feature} geometry The geometry to render. + * @override * @api */ ol.render.webgl.Immediate.prototype.drawGeometry = function(geometry) { diff --git a/src/ol/renderer/webgl/tilelayer.js b/src/ol/renderer/webgl/tilelayer.js index 45667be6c5..ef575668c9 100644 --- a/src/ol/renderer/webgl/tilelayer.js +++ b/src/ol/renderer/webgl/tilelayer.js @@ -97,15 +97,7 @@ if (ol.ENABLE_WEBGL) { /** - * Create a function that adds loaded tiles to the tile lookup. - * @param {ol.source.Tile} source Tile source. - * @param {ol.proj.Projection} projection Projection of the tiles. - * @param {Object.>} tiles Lookup of loaded - * tiles by zoom level. - * @return {function(number, ol.TileRange):boolean} A function that can be - * called with a zoom level and a tile range to add loaded tiles to the - * lookup. - * @protected + * @inheritDoc */ ol.renderer.webgl.TileLayer.prototype.createLoadedTileFinder = function(source, projection, tiles) { var mapRenderer = this.mapRenderer; diff --git a/src/ol/source/image.js b/src/ol/source/image.js index 8712cb42db..9e07a935ce 100644 --- a/src/ol/source/image.js +++ b/src/ol/source/image.js @@ -57,6 +57,7 @@ ol.inherits(ol.source.Image, ol.source.Source); /** * @return {Array.} Resolutions. + * @override */ ol.source.Image.prototype.getResolutions = function() { return this.resolutions_; diff --git a/src/ol/source/tiledebug.js b/src/ol/source/tiledebug.js index 4325f16124..3e301386cc 100644 --- a/src/ol/source/tiledebug.js +++ b/src/ol/source/tiledebug.js @@ -91,6 +91,7 @@ ol.inherits(ol.source.TileDebug.Tile_, ol.Tile); /** * Get the image element for this tile. * @return {HTMLCanvasElement} Image. + * @override */ ol.source.TileDebug.Tile_.prototype.getImage = function() { if (this.canvas_) { diff --git a/src/ol/source/tileutfgrid.js b/src/ol/source/tileutfgrid.js index f79f3e5978..a4410f9657 100644 --- a/src/ol/source/tileutfgrid.js +++ b/src/ol/source/tileutfgrid.js @@ -320,6 +320,7 @@ ol.inherits(ol.source.TileUTFGrid.Tile_, ol.Tile); /** * Get the image element for this tile. * @return {Image} Image. + * @override */ ol.source.TileUTFGrid.Tile_.prototype.getImage = function() { return null; @@ -479,7 +480,7 @@ ol.source.TileUTFGrid.Tile_.prototype.onXHRError_ = function(event) { /** - * Load not yet loaded URI. + * @inheritDoc */ ol.source.TileUTFGrid.Tile_.prototype.load = function() { if (this.preemptive_) { diff --git a/src/ol/style/circle.js b/src/ol/style/circle.js index 6b67d83920..acf8512ce5 100644 --- a/src/ol/style/circle.js +++ b/src/ol/style/circle.js @@ -33,6 +33,7 @@ ol.inherits(ol.style.Circle, ol.style.RegularShape); /** * Clones the style. If an atlasmanager was provided to the original style it will be used in the cloned style, too. * @return {ol.style.Circle} The cloned style. + * @override * @api */ ol.style.Circle.prototype.clone = function() { diff --git a/src/ol/style/icon.js b/src/ol/style/icon.js index 1628fec65c..8d57ed258d 100644 --- a/src/ol/style/icon.js +++ b/src/ol/style/icon.js @@ -275,6 +275,7 @@ ol.style.Icon.prototype.getColor = function() { * Get the image icon. * @param {number} pixelRatio Pixel ratio. * @return {Image|HTMLCanvasElement} Image or Canvas element. + * @override * @api */ ol.style.Icon.prototype.getImage = function(pixelRatio) { @@ -283,8 +284,7 @@ ol.style.Icon.prototype.getImage = function(pixelRatio) { /** - * Real Image size used. - * @return {ol.Size} Size. + * @inheritDoc */ ol.style.Icon.prototype.getImageSize = function() { return this.iconImage_.getSize(); @@ -379,6 +379,7 @@ ol.style.Icon.prototype.listenImageChange = function(listener, thisArg) { * When rendering a feature with an icon style, the vector renderer will * automatically call this method. However, you might want to call this * method yourself for preloading or other purposes. + * @override * @api */ ol.style.Icon.prototype.load = function() { diff --git a/src/ol/vectortile.js b/src/ol/vectortile.js index b32e339af6..c807e5e102 100644 --- a/src/ol/vectortile.js +++ b/src/ol/vectortile.js @@ -139,7 +139,7 @@ ol.VectorTile.prototype.getProjection = function() { /** - * Load the tile. + * @inheritDoc */ ol.VectorTile.prototype.load = function() { if (this.state == ol.TileState.IDLE) {