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
+1
View File
@@ -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() {
+2
View File
@@ -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) {
+3
View File
@@ -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.<ol.Coordinate>} 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.<ol.Coordinate>} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @override
* @api stable
*/
ol.geom.LinearRing.prototype.setCoordinates = function(coordinates, opt_layout) {
+3
View File
@@ -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.<ol.Coordinate>} 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.<ol.Coordinate>} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @override
* @api stable
*/
ol.geom.LineString.prototype.setCoordinates = function(coordinates, opt_layout) {
+3
View File
@@ -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.<Array.<ol.Coordinate>>} 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.<Array.<ol.Coordinate>>} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @override
* @api stable
*/
ol.geom.MultiLineString.prototype.setCoordinates = function(coordinates, opt_layout) {
+3
View File
@@ -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.<ol.Coordinate>} 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.<ol.Coordinate>} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @override
* @api stable
*/
ol.geom.MultiPoint.prototype.setCoordinates = function(coordinates, opt_layout) {
+3
View File
@@ -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.<Array.<Array.<ol.Coordinate>>>} 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.<Array.<Array.<ol.Coordinate>>>} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @override
* @api stable
*/
ol.geom.MultiPolygon.prototype.setCoordinates = function(coordinates, opt_layout) {
+3 -3
View File
@@ -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) {
+3
View File
@@ -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.<Array.<ol.Coordinate>>} 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.<Array.<ol.Coordinate>>} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @override
* @api stable
*/
ol.geom.Polygon.prototype.setCoordinates = function(coordinates, opt_layout) {