Remove all docstrings from oli.js

Instead, make sure that the properties are documented in the
implementing class.
This commit is contained in:
Andreas Hocevar
2014-05-22 18:00:10 +02:00
parent 547334e211
commit f903849882
2 changed files with 3 additions and 9 deletions

View File

@@ -15,7 +15,6 @@ oli.CollectionEvent;
/** /**
* The element that is added to or removed from the collection.
* @type {*} * @type {*}
*/ */
oli.CollectionEvent.prototype.element; oli.CollectionEvent.prototype.element;
@@ -38,7 +37,6 @@ oli.DrawEvent;
/** /**
* The feature being drawn.
* @type {ol.Feature} * @type {ol.Feature}
*/ */
oli.DrawEvent.prototype.feature; oli.DrawEvent.prototype.feature;
@@ -118,8 +116,6 @@ oli.render.Event;
/** /**
* Canvas context. Only available when a Canvas renderer is used, null
* otherwise.
* @type {CanvasRenderingContext2D|null|undefined} * @type {CanvasRenderingContext2D|null|undefined}
*/ */
oli.render.Event.prototype.context; oli.render.Event.prototype.context;
@@ -132,14 +128,12 @@ oli.render.Event.prototype.frameState;
/** /**
* WebGL context. Only available when a WebGL renderer is used, null otherwise.
* @type {ol.webgl.Context|null|undefined} * @type {ol.webgl.Context|null|undefined}
*/ */
oli.render.Event.prototype.glContext; oli.render.Event.prototype.glContext;
/** /**
* For canvas, this is an instance of {@link ol.render.canvas.Immediate}.
* @type {ol.render.IVectorContext|undefined} * @type {ol.render.IVectorContext|undefined}
*/ */
oli.render.Event.prototype.vectorContext; oli.render.Event.prototype.vectorContext;
@@ -151,7 +145,6 @@ oli.source.VectorEvent;
/** /**
* The feature being added or removed.
* @type {ol.Feature} * @type {ol.Feature}
*/ */
oli.source.VectorEvent.prototype.feature; oli.source.VectorEvent.prototype.feature;

View File

@@ -46,6 +46,7 @@ ol.render.Event = function(
goog.base(this, type, opt_target); goog.base(this, type, opt_target);
/** /**
* For canvas, this is an instance of {@link ol.render.canvas.Immediate}.
* @type {ol.render.IVectorContext|undefined} * @type {ol.render.IVectorContext|undefined}
* @todo api * @todo api
*/ */
@@ -58,8 +59,8 @@ ol.render.Event = function(
this.frameState = opt_frameState; this.frameState = opt_frameState;
/** /**
* Canvas context. Only available when a Canvas renderer is used, * Canvas context. Only available when a Canvas renderer is used, null
* null otherwise. * otherwise.
* @type {CanvasRenderingContext2D|null|undefined} * @type {CanvasRenderingContext2D|null|undefined}
* @todo api * @todo api
*/ */