Add missing override and inheritDoc jsdoc tags

This commit is contained in:
Frederic Junod
2016-12-16 15:49:53 +01:00
committed by Guillaume Beraudo
parent 546fc97cd4
commit d59224f5eb
34 changed files with 77 additions and 37 deletions

View File

@@ -101,6 +101,7 @@ ol.control.Control.prototype.getMap = function() {
* Subclasses may set up event handlers to get notified about changes to * Subclasses may set up event handlers to get notified about changes to
* the map here. * the map here.
* @param {ol.Map} map Map. * @param {ol.Map} map Map.
* @override
* @api stable * @api stable
*/ */
ol.control.Control.prototype.setMap = function(map) { ol.control.Control.prototype.setMap = function(map) {

View File

@@ -42,6 +42,7 @@ ol.events.Event = function(type) {
/** /**
* Stop event propagation. * Stop event propagation.
* @function * @function
* @override
* @api stable * @api stable
*/ */
ol.events.Event.prototype.preventDefault = ol.events.Event.prototype.preventDefault =
@@ -49,6 +50,7 @@ ol.events.Event.prototype.preventDefault =
/** /**
* Stop event propagation. * Stop event propagation.
* @function * @function
* @override
* @api stable * @api stable
*/ */
ol.events.Event.prototype.stopPropagation = function() { ol.events.Event.prototype.stopPropagation = function() {

View File

@@ -582,6 +582,7 @@ ol.format.EsriJSON.prototype.writeGeometry;
* @param {ol.geom.Geometry} geometry Geometry. * @param {ol.geom.Geometry} geometry Geometry.
* @param {olx.format.WriteOptions=} opt_options Write options. * @param {olx.format.WriteOptions=} opt_options Write options.
* @return {EsriJSONGeometry} Object. * @return {EsriJSONGeometry} Object.
* @override
* @api * @api
*/ */
ol.format.EsriJSON.prototype.writeGeometryObject = function(geometry, ol.format.EsriJSON.prototype.writeGeometryObject = function(geometry,
@@ -609,6 +610,7 @@ ol.format.EsriJSON.prototype.writeFeature;
* @param {ol.Feature} feature Feature. * @param {ol.Feature} feature Feature.
* @param {olx.format.WriteOptions=} opt_options Write options. * @param {olx.format.WriteOptions=} opt_options Write options.
* @return {Object} Object. * @return {Object} Object.
* @override
* @api * @api
*/ */
ol.format.EsriJSON.prototype.writeFeatureObject = function( ol.format.EsriJSON.prototype.writeFeatureObject = function(
@@ -655,6 +657,7 @@ ol.format.EsriJSON.prototype.writeFeatures;
* @param {Array.<ol.Feature>} features Features. * @param {Array.<ol.Feature>} features Features.
* @param {olx.format.WriteOptions=} opt_options Write options. * @param {olx.format.WriteOptions=} opt_options Write options.
* @return {Object} EsriJSON Object. * @return {Object} EsriJSON Object.
* @override
* @api * @api
*/ */
ol.format.EsriJSON.prototype.writeFeaturesObject = function(features, opt_options) { ol.format.EsriJSON.prototype.writeFeaturesObject = function(features, opt_options) {

View File

@@ -479,6 +479,7 @@ ol.format.GeoJSON.prototype.readProjectionFromObject = function(object) {
* @param {ol.Feature} feature Feature. * @param {ol.Feature} feature Feature.
* @param {olx.format.WriteOptions=} opt_options Write options. * @param {olx.format.WriteOptions=} opt_options Write options.
* @return {string} GeoJSON. * @return {string} GeoJSON.
* @override
* @api stable * @api stable
*/ */
ol.format.GeoJSON.prototype.writeFeature; ol.format.GeoJSON.prototype.writeFeature;
@@ -490,6 +491,7 @@ ol.format.GeoJSON.prototype.writeFeature;
* @param {ol.Feature} feature Feature. * @param {ol.Feature} feature Feature.
* @param {olx.format.WriteOptions=} opt_options Write options. * @param {olx.format.WriteOptions=} opt_options Write options.
* @return {GeoJSONFeature} Object. * @return {GeoJSONFeature} Object.
* @override
* @api stable * @api stable
*/ */
ol.format.GeoJSON.prototype.writeFeatureObject = function(feature, opt_options) { ol.format.GeoJSON.prototype.writeFeatureObject = function(feature, opt_options) {
@@ -538,6 +540,7 @@ ol.format.GeoJSON.prototype.writeFeatures;
* @param {Array.<ol.Feature>} features Features. * @param {Array.<ol.Feature>} features Features.
* @param {olx.format.WriteOptions=} opt_options Write options. * @param {olx.format.WriteOptions=} opt_options Write options.
* @return {GeoJSONFeatureCollection} GeoJSON Object. * @return {GeoJSONFeatureCollection} GeoJSON Object.
* @override
* @api stable * @api stable
*/ */
ol.format.GeoJSON.prototype.writeFeaturesObject = function(features, opt_options) { 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 {ol.geom.Geometry} geometry Geometry.
* @param {olx.format.WriteOptions=} opt_options Write options. * @param {olx.format.WriteOptions=} opt_options Write options.
* @return {GeoJSONGeometry|GeoJSONGeometryCollection} Object. * @return {GeoJSONGeometry|GeoJSONGeometryCollection} Object.
* @override
* @api stable * @api stable
*/ */
ol.format.GeoJSON.prototype.writeGeometryObject = function(geometry, ol.format.GeoJSON.prototype.writeGeometryObject = function(geometry,

View File

@@ -1162,6 +1162,7 @@ ol.format.GML3.prototype.GEOMETRY_NODE_FACTORY_ = function(value, objectStack, o
* @param {ol.geom.Geometry} geometry Geometry. * @param {ol.geom.Geometry} geometry Geometry.
* @param {olx.format.WriteOptions=} opt_options Options. * @param {olx.format.WriteOptions=} opt_options Options.
* @return {Node} Node. * @return {Node} Node.
* @override
* @api * @api
*/ */
ol.format.GML3.prototype.writeGeometryNode = function(geometry, opt_options) { ol.format.GML3.prototype.writeGeometryNode = function(geometry, opt_options) {
@@ -1196,6 +1197,7 @@ ol.format.GML3.prototype.writeFeatures;
* @param {Array.<ol.Feature>} features Features. * @param {Array.<ol.Feature>} features Features.
* @param {olx.format.WriteOptions=} opt_options Options. * @param {olx.format.WriteOptions=} opt_options Options.
* @return {Node} Node. * @return {Node} Node.
* @override
* @api * @api
*/ */
ol.format.GML3.prototype.writeFeaturesNode = function(features, opt_options) { ol.format.GML3.prototype.writeFeaturesNode = function(features, opt_options) {

View File

@@ -926,6 +926,7 @@ ol.format.GPX.prototype.writeFeatures;
* @param {Array.<ol.Feature>} features Features. * @param {Array.<ol.Feature>} features Features.
* @param {olx.format.WriteOptions=} opt_options Options. * @param {olx.format.WriteOptions=} opt_options Options.
* @return {Node} Node. * @return {Node} Node.
* @override
* @api * @api
*/ */
ol.format.GPX.prototype.writeFeaturesNode = function(features, opt_options) { ol.format.GPX.prototype.writeFeaturesNode = function(features, opt_options) {

View File

@@ -3018,6 +3018,7 @@ ol.format.KML.prototype.writeFeatures;
* @param {Array.<ol.Feature>} features Features. * @param {Array.<ol.Feature>} features Features.
* @param {olx.format.WriteOptions=} opt_options Options. * @param {olx.format.WriteOptions=} opt_options Options.
* @return {Node} Node. * @return {Node} Node.
* @override
* @api * @api
*/ */
ol.format.KML.prototype.writeFeaturesNode = function(features, opt_options) { ol.format.KML.prototype.writeFeaturesNode = function(features, opt_options) {

View File

@@ -18,8 +18,7 @@ ol.inherits(ol.format.OWS, ol.format.XML);
/** /**
* @param {Document} doc Document. * @inheritDoc
* @return {Object} OWS object.
*/ */
ol.format.OWS.prototype.readFromDocument = function(doc) { ol.format.OWS.prototype.readFromDocument = function(doc) {
for (var n = doc.firstChild; n; n = n.nextSibling) { for (var n = doc.firstChild; n; n = n.nextSibling) {
@@ -32,8 +31,7 @@ ol.format.OWS.prototype.readFromDocument = function(doc) {
/** /**
* @param {Node} node Node. * @inheritDoc
* @return {Object} OWS object.
*/ */
ol.format.OWS.prototype.readFromNode = function(node) { ol.format.OWS.prototype.readFromNode = function(node) {
var owsObject = ol.xml.pushParseAndPop({}, var owsObject = ol.xml.pushParseAndPop({},

View File

@@ -366,9 +366,9 @@ ol.format.TopoJSON.transformVertex_ = function(vertex, scale, translate) {
/** /**
* Read the projection from a TopoJSON source. * Read the projection from a TopoJSON source.
* *
* @function
* @param {Document|Node|Object|string} object Source. * @param {Document|Node|Object|string} object Source.
* @return {ol.proj.Projection} Projection. * @return {ol.proj.Projection} Projection.
* @override
* @api stable * @api stable
*/ */
ol.format.TopoJSON.prototype.readProjection = function(object) { ol.format.TopoJSON.prototype.readProjection = function(object) {

View File

@@ -39,8 +39,7 @@ ol.format.WMSCapabilities.prototype.read;
/** /**
* @param {Document} doc Document. * @inheritDoc
* @return {Object} WMS Capability object.
*/ */
ol.format.WMSCapabilities.prototype.readFromDocument = function(doc) { ol.format.WMSCapabilities.prototype.readFromDocument = function(doc) {
for (var n = doc.firstChild; n; n = n.nextSibling) { for (var n = doc.firstChild; n; n = n.nextSibling) {
@@ -53,8 +52,7 @@ ol.format.WMSCapabilities.prototype.readFromDocument = function(doc) {
/** /**
* @param {Node} node Node. * @inheritDoc
* @return {Object} WMS Capability object.
*/ */
ol.format.WMSCapabilities.prototype.readFromNode = function(node) { ol.format.WMSCapabilities.prototype.readFromNode = function(node) {
this.version = node.getAttribute('version').trim(); this.version = node.getAttribute('version').trim();

View File

@@ -41,8 +41,7 @@ ol.format.WMTSCapabilities.prototype.read;
/** /**
* @param {Document} doc Document. * @inheritDoc
* @return {Object} WMTS Capability object.
*/ */
ol.format.WMTSCapabilities.prototype.readFromDocument = function(doc) { ol.format.WMTSCapabilities.prototype.readFromDocument = function(doc) {
for (var n = doc.firstChild; n; n = n.nextSibling) { for (var n = doc.firstChild; n; n = n.nextSibling) {
@@ -55,8 +54,7 @@ ol.format.WMTSCapabilities.prototype.readFromDocument = function(doc) {
/** /**
* @param {Node} node Node. * @inheritDoc
* @return {Object} WMTS Capability object.
*/ */
ol.format.WMTSCapabilities.prototype.readFromNode = function(node) { ol.format.WMTSCapabilities.prototype.readFromNode = function(node) {
var version = node.getAttribute('version').trim(); var version = node.getAttribute('version').trim();

View File

@@ -30,6 +30,7 @@ ol.inherits(ol.geom.Circle, ol.geom.SimpleGeometry);
/** /**
* Make a complete copy of the geometry. * Make a complete copy of the geometry.
* @return {!ol.geom.Circle} Clone. * @return {!ol.geom.Circle} Clone.
* @override
* @api * @api
*/ */
ol.geom.Circle.prototype.clone = function() { ol.geom.Circle.prototype.clone = function() {

View File

@@ -83,6 +83,7 @@ ol.geom.GeometryCollection.prototype.listenGeometriesChange_ = function() {
/** /**
* Make a complete copy of the geometry. * Make a complete copy of the geometry.
* @return {!ol.geom.GeometryCollection} Clone. * @return {!ol.geom.GeometryCollection} Clone.
* @override
* @api stable * @api stable
*/ */
ol.geom.GeometryCollection.prototype.clone = function() { ol.geom.GeometryCollection.prototype.clone = function() {
@@ -302,6 +303,7 @@ ol.geom.GeometryCollection.prototype.applyTransform = function(transformFn) {
* Translate the geometry. * Translate the geometry.
* @param {number} deltaX Delta X. * @param {number} deltaX Delta X.
* @param {number} deltaY Delta Y. * @param {number} deltaY Delta Y.
* @override
* @api * @api
*/ */
ol.geom.GeometryCollection.prototype.translate = function(deltaX, deltaY) { ol.geom.GeometryCollection.prototype.translate = function(deltaX, deltaY) {

View File

@@ -48,6 +48,7 @@ ol.inherits(ol.geom.LinearRing, ol.geom.SimpleGeometry);
/** /**
* Make a complete copy of the geometry. * Make a complete copy of the geometry.
* @return {!ol.geom.LinearRing} Clone. * @return {!ol.geom.LinearRing} Clone.
* @override
* @api stable * @api stable
*/ */
ol.geom.LinearRing.prototype.clone = function() { ol.geom.LinearRing.prototype.clone = function() {
@@ -90,6 +91,7 @@ ol.geom.LinearRing.prototype.getArea = function() {
/** /**
* Return the coordinates of the linear ring. * Return the coordinates of the linear ring.
* @return {Array.<ol.Coordinate>} Coordinates. * @return {Array.<ol.Coordinate>} Coordinates.
* @override
* @api stable * @api stable
*/ */
ol.geom.LinearRing.prototype.getCoordinates = function() { ol.geom.LinearRing.prototype.getCoordinates = function() {
@@ -126,6 +128,7 @@ ol.geom.LinearRing.prototype.getType = function() {
* Set the coordinates of the linear ring. * Set the coordinates of the linear ring.
* @param {Array.<ol.Coordinate>} coordinates Coordinates. * @param {Array.<ol.Coordinate>} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout. * @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @override
* @api stable * @api stable
*/ */
ol.geom.LinearRing.prototype.setCoordinates = function(coordinates, opt_layout) { ol.geom.LinearRing.prototype.setCoordinates = function(coordinates, opt_layout) {

View File

@@ -78,6 +78,7 @@ ol.geom.LineString.prototype.appendCoordinate = function(coordinate) {
/** /**
* Make a complete copy of the geometry. * Make a complete copy of the geometry.
* @return {!ol.geom.LineString} Clone. * @return {!ol.geom.LineString} Clone.
* @override
* @api stable * @api stable
*/ */
ol.geom.LineString.prototype.clone = function() { 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 the coordinates of the linestring.
* @return {Array.<ol.Coordinate>} Coordinates. * @return {Array.<ol.Coordinate>} Coordinates.
* @override
* @api stable * @api stable
*/ */
ol.geom.LineString.prototype.getCoordinates = function() { ol.geom.LineString.prototype.getCoordinates = function() {
@@ -240,6 +242,7 @@ ol.geom.LineString.prototype.intersectsExtent = function(extent) {
* Set the coordinates of the linestring. * Set the coordinates of the linestring.
* @param {Array.<ol.Coordinate>} coordinates Coordinates. * @param {Array.<ol.Coordinate>} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout. * @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @override
* @api stable * @api stable
*/ */
ol.geom.LineString.prototype.setCoordinates = function(coordinates, opt_layout) { ol.geom.LineString.prototype.setCoordinates = function(coordinates, opt_layout) {

View File

@@ -73,6 +73,7 @@ ol.geom.MultiLineString.prototype.appendLineString = function(lineString) {
/** /**
* Make a complete copy of the geometry. * Make a complete copy of the geometry.
* @return {!ol.geom.MultiLineString} Clone. * @return {!ol.geom.MultiLineString} Clone.
* @override
* @api stable * @api stable
*/ */
ol.geom.MultiLineString.prototype.clone = function() { 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 the coordinates of the multilinestring.
* @return {Array.<Array.<ol.Coordinate>>} Coordinates. * @return {Array.<Array.<ol.Coordinate>>} Coordinates.
* @override
* @api stable * @api stable
*/ */
ol.geom.MultiLineString.prototype.getCoordinates = function() { ol.geom.MultiLineString.prototype.getCoordinates = function() {
@@ -257,6 +259,7 @@ ol.geom.MultiLineString.prototype.intersectsExtent = function(extent) {
* Set the coordinates of the multilinestring. * Set the coordinates of the multilinestring.
* @param {Array.<Array.<ol.Coordinate>>} coordinates Coordinates. * @param {Array.<Array.<ol.Coordinate>>} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout. * @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @override
* @api stable * @api stable
*/ */
ol.geom.MultiLineString.prototype.setCoordinates = function(coordinates, opt_layout) { ol.geom.MultiLineString.prototype.setCoordinates = function(coordinates, opt_layout) {

View File

@@ -47,6 +47,7 @@ ol.geom.MultiPoint.prototype.appendPoint = function(point) {
/** /**
* Make a complete copy of the geometry. * Make a complete copy of the geometry.
* @return {!ol.geom.MultiPoint} Clone. * @return {!ol.geom.MultiPoint} Clone.
* @override
* @api stable * @api stable
*/ */
ol.geom.MultiPoint.prototype.clone = function() { 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 the coordinates of the multipoint.
* @return {Array.<ol.Coordinate>} Coordinates. * @return {Array.<ol.Coordinate>} Coordinates.
* @override
* @api stable * @api stable
*/ */
ol.geom.MultiPoint.prototype.getCoordinates = function() { ol.geom.MultiPoint.prototype.getCoordinates = function() {
@@ -165,6 +167,7 @@ ol.geom.MultiPoint.prototype.intersectsExtent = function(extent) {
* Set the coordinates of the multipoint. * Set the coordinates of the multipoint.
* @param {Array.<ol.Coordinate>} coordinates Coordinates. * @param {Array.<ol.Coordinate>} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout. * @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @override
* @api stable * @api stable
*/ */
ol.geom.MultiPoint.prototype.setCoordinates = function(coordinates, opt_layout) { ol.geom.MultiPoint.prototype.setCoordinates = function(coordinates, opt_layout) {

View File

@@ -111,6 +111,7 @@ ol.geom.MultiPolygon.prototype.appendPolygon = function(polygon) {
/** /**
* Make a complete copy of the geometry. * Make a complete copy of the geometry.
* @return {!ol.geom.MultiPolygon} Clone. * @return {!ol.geom.MultiPolygon} Clone.
* @override
* @api stable * @api stable
*/ */
ol.geom.MultiPolygon.prototype.clone = function() { 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 * By default, coordinate orientation will depend on how the geometry was
* constructed. * constructed.
* @return {Array.<Array.<Array.<ol.Coordinate>>>} Coordinates. * @return {Array.<Array.<Array.<ol.Coordinate>>>} Coordinates.
* @override
* @api stable * @api stable
*/ */
ol.geom.MultiPolygon.prototype.getCoordinates = function(opt_right) { 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. * Set the coordinates of the multipolygon.
* @param {Array.<Array.<Array.<ol.Coordinate>>>} coordinates Coordinates. * @param {Array.<Array.<Array.<ol.Coordinate>>>} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout. * @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @override
* @api stable * @api stable
*/ */
ol.geom.MultiPolygon.prototype.setCoordinates = function(coordinates, opt_layout) { ol.geom.MultiPolygon.prototype.setCoordinates = function(coordinates, opt_layout) {

View File

@@ -29,6 +29,7 @@ ol.inherits(ol.geom.Point, ol.geom.SimpleGeometry);
/** /**
* Make a complete copy of the geometry. * Make a complete copy of the geometry.
* @return {!ol.geom.Point} Clone. * @return {!ol.geom.Point} Clone.
* @override
* @api stable * @api stable
*/ */
ol.geom.Point.prototype.clone = function() { 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 the coordinate of the point.
* @return {ol.Coordinate} Coordinates. * @return {ol.Coordinate} Coordinates.
* @override
* @api stable * @api stable
*/ */
ol.geom.Point.prototype.getCoordinates = function() { ol.geom.Point.prototype.getCoordinates = function() {
@@ -97,9 +99,7 @@ ol.geom.Point.prototype.intersectsExtent = function(extent) {
/** /**
* Set the coordinate of the point. * @inheritDoc
* @param {ol.Coordinate} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @api stable * @api stable
*/ */
ol.geom.Point.prototype.setCoordinates = function(coordinates, opt_layout) { ol.geom.Point.prototype.setCoordinates = function(coordinates, opt_layout) {

View File

@@ -106,6 +106,7 @@ ol.geom.Polygon.prototype.appendLinearRing = function(linearRing) {
/** /**
* Make a complete copy of the geometry. * Make a complete copy of the geometry.
* @return {!ol.geom.Polygon} Clone. * @return {!ol.geom.Polygon} Clone.
* @override
* @api stable * @api stable
*/ */
ol.geom.Polygon.prototype.clone = function() { 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 * By default, coordinate orientation will depend on how the geometry was
* constructed. * constructed.
* @return {Array.<Array.<ol.Coordinate>>} Coordinates. * @return {Array.<Array.<ol.Coordinate>>} Coordinates.
* @override
* @api stable * @api stable
*/ */
ol.geom.Polygon.prototype.getCoordinates = function(opt_right) { 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. * Set the coordinates of the polygon.
* @param {Array.<Array.<ol.Coordinate>>} coordinates Coordinates. * @param {Array.<Array.<ol.Coordinate>>} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout. * @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @override
* @api stable * @api stable
*/ */
ol.geom.Polygon.prototype.setCoordinates = function(coordinates, opt_layout) { ol.geom.Polygon.prototype.setCoordinates = function(coordinates, opt_layout) {

View File

@@ -70,9 +70,7 @@ ol.inherits(ol.Image, ol.ImageBase);
/** /**
* Get the HTML image element (may be a Canvas, Image, or Video). * @inheritDoc
* @param {Object=} opt_context Object.
* @return {HTMLCanvasElement|Image|HTMLVideoElement} Image.
* @api * @api
*/ */
ol.Image.prototype.getImage = function(opt_context) { 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. * Load the image or retry if loading previously failed.
* Loading is taken care of by the tile queue, and calling this method is * 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. * only needed for preloading or for reloading in case of an error.
* @override
* @api * @api
*/ */
ol.Image.prototype.load = function() { ol.Image.prototype.load = function() {

View File

@@ -73,7 +73,7 @@ ol.ImageCanvas.prototype.handleLoad_ = function(err) {
/** /**
* Trigger drawing on canvas. * @inheritDoc
*/ */
ol.ImageCanvas.prototype.load = function() { ol.ImageCanvas.prototype.load = function() {
if (this.state == ol.ImageState.IDLE) { if (this.state == ol.ImageState.IDLE) {

View File

@@ -116,9 +116,7 @@ ol.ImageTile.prototype.handleImageLoad_ = function() {
/** /**
* Load the image or retry if loading previously failed. * @inheritDoc
* 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.
* @api * @api
*/ */
ol.ImageTile.prototype.load = function() { ol.ImageTile.prototype.load = function() {

View File

@@ -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 * 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. * map, if any. Pass `null` to just remove the interaction from the current map.
* @param {ol.Map} map Map. * @param {ol.Map} map Map.
* @override
* @api stable * @api stable
*/ */
ol.interaction.Select.prototype.setMap = function(map) { ol.interaction.Select.prototype.setMap = function(map) {

View File

@@ -397,6 +397,7 @@ ol.render.canvas.Immediate.prototype.drawRings_ = function(flatCoordinates, offs
* the current fill and stroke styles. * the current fill and stroke styles.
* *
* @param {ol.geom.Circle} geometry Circle geometry. * @param {ol.geom.Circle} geometry Circle geometry.
* @override
* @api * @api
*/ */
ol.render.canvas.Immediate.prototype.drawCircle = function(geometry) { 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. * any `zIndex` on the provided style will be ignored.
* *
* @param {ol.style.Style} style The rendering style. * @param {ol.style.Style} style The rendering style.
* @override
* @api * @api
*/ */
ol.render.canvas.Immediate.prototype.setStyle = function(style) { 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. * {@link ol.render.canvas.Immediate#setStyle} first to set the rendering style.
* *
* @param {ol.geom.Geometry|ol.render.Feature} geometry The geometry to render. * @param {ol.geom.Geometry|ol.render.Feature} geometry The geometry to render.
* @override
* @api * @api
*/ */
ol.render.canvas.Immediate.prototype.drawGeometry = function(geometry) { 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.Feature} feature Feature.
* @param {ol.style.Style} style Style. * @param {ol.style.Style} style Style.
* @override
* @api * @api
*/ */
ol.render.canvas.Immediate.prototype.drawFeature = function(feature, style) { 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. * uses the current styles appropriate for each geometry in the collection.
* *
* @param {ol.geom.GeometryCollection} geometry Geometry collection. * @param {ol.geom.GeometryCollection} geometry Geometry collection.
* @override
*/ */
ol.render.canvas.Immediate.prototype.drawGeometryCollection = function(geometry) { ol.render.canvas.Immediate.prototype.drawGeometryCollection = function(geometry) {
var geometries = geometry.getGeometriesArray(); var geometries = geometry.getGeometriesArray();
@@ -526,6 +531,7 @@ ol.render.canvas.Immediate.prototype.drawGeometryCollection = function(geometry)
* the current style. * the current style.
* *
* @param {ol.geom.Point|ol.render.Feature} geometry Point geometry. * @param {ol.geom.Point|ol.render.Feature} geometry Point geometry.
* @override
*/ */
ol.render.canvas.Immediate.prototype.drawPoint = function(geometry) { ol.render.canvas.Immediate.prototype.drawPoint = function(geometry) {
var flatCoordinates = geometry.getFlatCoordinates(); var flatCoordinates = geometry.getFlatCoordinates();
@@ -544,6 +550,7 @@ ol.render.canvas.Immediate.prototype.drawPoint = function(geometry) {
* uses the current style. * uses the current style.
* *
* @param {ol.geom.MultiPoint|ol.render.Feature} geometry MultiPoint geometry. * @param {ol.geom.MultiPoint|ol.render.Feature} geometry MultiPoint geometry.
* @override
*/ */
ol.render.canvas.Immediate.prototype.drawMultiPoint = function(geometry) { ol.render.canvas.Immediate.prototype.drawMultiPoint = function(geometry) {
var flatCoordinates = geometry.getFlatCoordinates(); var flatCoordinates = geometry.getFlatCoordinates();
@@ -562,6 +569,7 @@ ol.render.canvas.Immediate.prototype.drawMultiPoint = function(geometry) {
* the current style. * the current style.
* *
* @param {ol.geom.LineString|ol.render.Feature} geometry LineString geometry. * @param {ol.geom.LineString|ol.render.Feature} geometry LineString geometry.
* @override
*/ */
ol.render.canvas.Immediate.prototype.drawLineString = function(geometry) { ol.render.canvas.Immediate.prototype.drawLineString = function(geometry) {
if (!ol.extent.intersects(this.extent_, geometry.getExtent())) { 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 * @param {ol.geom.MultiLineString|ol.render.Feature} geometry MultiLineString
* geometry. * geometry.
* @override
*/ */
ol.render.canvas.Immediate.prototype.drawMultiLineString = function(geometry) { ol.render.canvas.Immediate.prototype.drawMultiLineString = function(geometry) {
var geometryExtent = geometry.getExtent(); var geometryExtent = geometry.getExtent();
@@ -622,6 +631,7 @@ ol.render.canvas.Immediate.prototype.drawMultiLineString = function(geometry) {
* the current style. * the current style.
* *
* @param {ol.geom.Polygon|ol.render.Feature} geometry Polygon geometry. * @param {ol.geom.Polygon|ol.render.Feature} geometry Polygon geometry.
* @override
*/ */
ol.render.canvas.Immediate.prototype.drawPolygon = function(geometry) { ol.render.canvas.Immediate.prototype.drawPolygon = function(geometry) {
if (!ol.extent.intersects(this.extent_, geometry.getExtent())) { 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 * Render MultiPolygon geometry into the canvas. Rendering is immediate and
* uses the current style. * uses the current style.
* @param {ol.geom.MultiPolygon} geometry MultiPolygon geometry. * @param {ol.geom.MultiPolygon} geometry MultiPolygon geometry.
* @override
*/ */
ol.render.canvas.Immediate.prototype.drawMultiPolygon = function(geometry) { ol.render.canvas.Immediate.prototype.drawMultiPolygon = function(geometry) {
if (!ol.extent.intersects(this.extent_, geometry.getExtent())) { 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.Fill} fillStyle Fill style.
* @param {ol.style.Stroke} strokeStyle Stroke style. * @param {ol.style.Stroke} strokeStyle Stroke style.
* @override
*/ */
ol.render.canvas.Immediate.prototype.setFillStrokeStyle = function(fillStyle, strokeStyle) { ol.render.canvas.Immediate.prototype.setFillStrokeStyle = function(fillStyle, strokeStyle) {
if (!fillStyle) { if (!fillStyle) {
@@ -848,6 +860,7 @@ ol.render.canvas.Immediate.prototype.setFillStrokeStyle = function(fillStyle, st
* the image style. * the image style.
* *
* @param {ol.style.Image} imageStyle Image style. * @param {ol.style.Image} imageStyle Image style.
* @override
*/ */
ol.render.canvas.Immediate.prototype.setImageStyle = function(imageStyle) { ol.render.canvas.Immediate.prototype.setImageStyle = function(imageStyle) {
if (!imageStyle) { if (!imageStyle) {
@@ -879,6 +892,7 @@ ol.render.canvas.Immediate.prototype.setImageStyle = function(imageStyle) {
* remove the text style. * remove the text style.
* *
* @param {ol.style.Text} textStyle Text style. * @param {ol.style.Text} textStyle Text style.
* @override
*/ */
ol.render.canvas.Immediate.prototype.setTextStyle = function(textStyle) { ol.render.canvas.Immediate.prototype.setTextStyle = function(textStyle) {
if (!textStyle) { if (!textStyle) {

View File

@@ -34,7 +34,7 @@ ol.render.VectorContext.prototype.setStyle = function(style) {};
/** /**
* @abstract * @abstract
* @param {ol.geom.Circle} circleGeometry Circle geometry. * @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) {}; ol.render.VectorContext.prototype.drawCircle = function(circleGeometry, feature) {};

View File

@@ -88,6 +88,7 @@ if (ol.ENABLE_WEBGL) {
* any `zIndex` on the provided style will be ignored. * any `zIndex` on the provided style will be ignored.
* *
* @param {ol.style.Style} style The rendering style. * @param {ol.style.Style} style The rendering style.
* @override
* @api * @api
*/ */
ol.render.webgl.Immediate.prototype.setStyle = function(style) { 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. * {@link ol.render.webgl.Immediate#setStyle} first to set the rendering style.
* *
* @param {ol.geom.Geometry|ol.render.Feature} geometry The geometry to render. * @param {ol.geom.Geometry|ol.render.Feature} geometry The geometry to render.
* @override
* @api * @api
*/ */
ol.render.webgl.Immediate.prototype.drawGeometry = function(geometry) { ol.render.webgl.Immediate.prototype.drawGeometry = function(geometry) {

View File

@@ -97,15 +97,7 @@ if (ol.ENABLE_WEBGL) {
/** /**
* Create a function that adds loaded tiles to the tile lookup. * @inheritDoc
* @param {ol.source.Tile} source Tile source.
* @param {ol.proj.Projection} projection Projection of the tiles.
* @param {Object.<number, Object.<string, ol.Tile>>} 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
*/ */
ol.renderer.webgl.TileLayer.prototype.createLoadedTileFinder = function(source, projection, tiles) { ol.renderer.webgl.TileLayer.prototype.createLoadedTileFinder = function(source, projection, tiles) {
var mapRenderer = this.mapRenderer; var mapRenderer = this.mapRenderer;

View File

@@ -57,6 +57,7 @@ ol.inherits(ol.source.Image, ol.source.Source);
/** /**
* @return {Array.<number>} Resolutions. * @return {Array.<number>} Resolutions.
* @override
*/ */
ol.source.Image.prototype.getResolutions = function() { ol.source.Image.prototype.getResolutions = function() {
return this.resolutions_; return this.resolutions_;

View File

@@ -91,6 +91,7 @@ ol.inherits(ol.source.TileDebug.Tile_, ol.Tile);
/** /**
* Get the image element for this tile. * Get the image element for this tile.
* @return {HTMLCanvasElement} Image. * @return {HTMLCanvasElement} Image.
* @override
*/ */
ol.source.TileDebug.Tile_.prototype.getImage = function() { ol.source.TileDebug.Tile_.prototype.getImage = function() {
if (this.canvas_) { if (this.canvas_) {

View File

@@ -320,6 +320,7 @@ ol.inherits(ol.source.TileUTFGrid.Tile_, ol.Tile);
/** /**
* Get the image element for this tile. * Get the image element for this tile.
* @return {Image} Image. * @return {Image} Image.
* @override
*/ */
ol.source.TileUTFGrid.Tile_.prototype.getImage = function() { ol.source.TileUTFGrid.Tile_.prototype.getImage = function() {
return null; 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() { ol.source.TileUTFGrid.Tile_.prototype.load = function() {
if (this.preemptive_) { if (this.preemptive_) {

View File

@@ -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. * 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. * @return {ol.style.Circle} The cloned style.
* @override
* @api * @api
*/ */
ol.style.Circle.prototype.clone = function() { ol.style.Circle.prototype.clone = function() {

View File

@@ -275,6 +275,7 @@ ol.style.Icon.prototype.getColor = function() {
* Get the image icon. * Get the image icon.
* @param {number} pixelRatio Pixel ratio. * @param {number} pixelRatio Pixel ratio.
* @return {Image|HTMLCanvasElement} Image or Canvas element. * @return {Image|HTMLCanvasElement} Image or Canvas element.
* @override
* @api * @api
*/ */
ol.style.Icon.prototype.getImage = function(pixelRatio) { ol.style.Icon.prototype.getImage = function(pixelRatio) {
@@ -283,8 +284,7 @@ ol.style.Icon.prototype.getImage = function(pixelRatio) {
/** /**
* Real Image size used. * @inheritDoc
* @return {ol.Size} Size.
*/ */
ol.style.Icon.prototype.getImageSize = function() { ol.style.Icon.prototype.getImageSize = function() {
return this.iconImage_.getSize(); 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 * When rendering a feature with an icon style, the vector renderer will
* automatically call this method. However, you might want to call this * automatically call this method. However, you might want to call this
* method yourself for preloading or other purposes. * method yourself for preloading or other purposes.
* @override
* @api * @api
*/ */
ol.style.Icon.prototype.load = function() { ol.style.Icon.prototype.load = function() {

View File

@@ -139,7 +139,7 @@ ol.VectorTile.prototype.getProjection = function() {
/** /**
* Load the tile. * @inheritDoc
*/ */
ol.VectorTile.prototype.load = function() { ol.VectorTile.prototype.load = function() {
if (this.state == ol.TileState.IDLE) { if (this.state == ol.TileState.IDLE) {