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

@@ -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) {

View File

@@ -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) {};

View File

@@ -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) {