Move oli.* stability notes to the corresponding ol.* symbol

This commit is contained in:
Andreas Hocevar
2014-05-22 16:01:35 +02:00
parent 2caa1139a1
commit 547334e211
9 changed files with 17 additions and 16 deletions

View File

@@ -17,7 +17,6 @@ oli.CollectionEvent;
/** /**
* The element that is added to or removed from the collection. * The element that is added to or removed from the collection.
* @type {*} * @type {*}
* @todo api
*/ */
oli.CollectionEvent.prototype.element; oli.CollectionEvent.prototype.element;
@@ -29,7 +28,6 @@ oli.DragBoxEvent;
/** /**
* @type {ol.Coordinate} * @type {ol.Coordinate}
* @todo api
*/ */
oli.DragBoxEvent.prototype.coordinate; oli.DragBoxEvent.prototype.coordinate;
@@ -42,7 +40,6 @@ oli.DrawEvent;
/** /**
* The feature being drawn. * The feature being drawn.
* @type {ol.Feature} * @type {ol.Feature}
* @todo api
*/ */
oli.DrawEvent.prototype.feature; oli.DrawEvent.prototype.feature;
@@ -63,21 +60,18 @@ oli.MapBrowserEvent;
/** /**
* @type {ol.Coordinate} * @type {ol.Coordinate}
* @todo api
*/ */
oli.MapBrowserEvent.prototype.coordinate; oli.MapBrowserEvent.prototype.coordinate;
/** /**
* @type {Event} * @type {Event}
* @todo api
*/ */
oli.MapBrowserEvent.prototype.originalEvent; oli.MapBrowserEvent.prototype.originalEvent;
/** /**
* @type {ol.Pixel} * @type {ol.Pixel}
* @todo api
*/ */
oli.MapBrowserEvent.prototype.pixel; oli.MapBrowserEvent.prototype.pixel;
@@ -103,21 +97,18 @@ oli.interaction.DragAndDropEvent;
/** /**
* @type {Array.<ol.Feature>|undefined} * @type {Array.<ol.Feature>|undefined}
* @todo api
*/ */
oli.interaction.DragAndDropEvent.prototype.features; oli.interaction.DragAndDropEvent.prototype.features;
/** /**
* @type {ol.proj.Projection|undefined} * @type {ol.proj.Projection|undefined}
* @todo api
*/ */
oli.interaction.DragAndDropEvent.prototype.projection; oli.interaction.DragAndDropEvent.prototype.projection;
/** /**
* @type {File} * @type {File}
* @todo api
*/ */
oli.interaction.DragAndDropEvent.prototype.file; oli.interaction.DragAndDropEvent.prototype.file;
@@ -130,14 +121,12 @@ oli.render.Event;
* Canvas context. Only available when a Canvas renderer is used, null * Canvas context. Only available when a Canvas renderer is used, null
* otherwise. * otherwise.
* @type {CanvasRenderingContext2D|null|undefined} * @type {CanvasRenderingContext2D|null|undefined}
* @todo api
*/ */
oli.render.Event.prototype.context; oli.render.Event.prototype.context;
/** /**
* @type {olx.FrameState|undefined} * @type {olx.FrameState|undefined}
* @todo api
*/ */
oli.render.Event.prototype.frameState; oli.render.Event.prototype.frameState;
@@ -145,7 +134,6 @@ oli.render.Event.prototype.frameState;
/** /**
* WebGL context. Only available when a WebGL renderer is used, null otherwise. * WebGL context. Only available when a WebGL renderer is used, null otherwise.
* @type {ol.webgl.Context|null|undefined} * @type {ol.webgl.Context|null|undefined}
* @todo api
*/ */
oli.render.Event.prototype.glContext; oli.render.Event.prototype.glContext;
@@ -153,7 +141,6 @@ oli.render.Event.prototype.glContext;
/** /**
* For canvas, this is an instance of {@link ol.render.canvas.Immediate}. * For canvas, this is an instance of {@link ol.render.canvas.Immediate}.
* @type {ol.render.IVectorContext|undefined} * @type {ol.render.IVectorContext|undefined}
* @todo api
*/ */
oli.render.Event.prototype.vectorContext; oli.render.Event.prototype.vectorContext;
@@ -166,6 +153,5 @@ oli.source.VectorEvent;
/** /**
* The feature being added or removed. * The feature being added or removed.
* @type {ol.Feature} * @type {ol.Feature}
* @todo api
*/ */
oli.source.VectorEvent.prototype.feature; oli.source.VectorEvent.prototype.feature;

View File

@@ -8,14 +8,14 @@ These two files are special externs that belong to ol3, and this document explai
### Prevent class properties from being renamed ### Prevent class properties from being renamed
For events, we make properties available to the application. Other than methods, which can be made available by just marking them with the `@api` annotation, properties are exported using `oli.js`: For events, we make properties available to the application. Other than methods, which can be made available by just marking them with the `@api` annotation directly where they are defined, properties need to be added to `oli.js` in addition:
```js ```js
/** @interface */ /** @interface */
oli.MapBrowserEvent; oli.MapBrowserEvent;
/** /**
* @type {ol.Coordinate} * @type {ol.Coordinate}
* @todo api
*/ */
oli.MapBrowserEvent.prototype.coordinate; oli.MapBrowserEvent.prototype.coordinate;
``` ```
@@ -32,6 +32,7 @@ ol.MapBrowserEvent = function(type, map, browserEvent, opt_frameState) {
/** /**
* @type {ol.Coordinate} * @type {ol.Coordinate}
* @todo api
*/ */
this.coordinate = map.getEventCoordinate(this.originalEvent); this.coordinate = map.getEventCoordinate(this.originalEvent);

View File

@@ -47,6 +47,7 @@ ol.CollectionEvent = function(type, opt_element, opt_target) {
/** /**
* The element that is added to or removed from the collection. * The element that is added to or removed from the collection.
* @type {*} * @type {*}
* @todo api
*/ */
this.element = opt_element; this.element = opt_element;

View File

@@ -205,16 +205,19 @@ ol.interaction.DragAndDropEvent =
/** /**
* @type {Array.<ol.Feature>|undefined} * @type {Array.<ol.Feature>|undefined}
* @todo api
*/ */
this.features = opt_features; this.features = opt_features;
/** /**
* @type {File} * @type {File}
* @todo api
*/ */
this.file = file; this.file = file;
/** /**
* @type {ol.proj.Projection|undefined} * @type {ol.proj.Projection|undefined}
* @todo api
*/ */
this.projection = opt_projection; this.projection = opt_projection;

View File

@@ -59,6 +59,7 @@ ol.DragBoxEvent = function(type, coordinate) {
* The coordinate of the drag event. * The coordinate of the drag event.
* @const * @const
* @type {ol.Coordinate} * @type {ol.Coordinate}
* @todo api
*/ */
this.coordinate = coordinate; this.coordinate = coordinate;

View File

@@ -56,6 +56,7 @@ ol.DrawEvent = function(type, feature) {
/** /**
* The feature being drawn. * The feature being drawn.
* @type {ol.Feature} * @type {ol.Feature}
* @todo api
*/ */
this.feature = feature; this.feature = feature;

View File

@@ -41,16 +41,19 @@ ol.MapBrowserEvent = function(type, map, browserEvent, opt_frameState) {
/** /**
* @const * @const
* @type {Event} * @type {Event}
* @todo api
*/ */
this.originalEvent = browserEvent.getBrowserEvent(); this.originalEvent = browserEvent.getBrowserEvent();
/** /**
* @type {ol.Coordinate} * @type {ol.Coordinate}
* @todo api
*/ */
this.coordinate = map.getEventCoordinate(this.originalEvent); this.coordinate = map.getEventCoordinate(this.originalEvent);
/** /**
* @type {ol.Pixel} * @type {ol.Pixel}
* @todo api
*/ */
this.pixel = map.getEventPixel(this.originalEvent); this.pixel = map.getEventPixel(this.originalEvent);

View File

@@ -47,11 +47,13 @@ ol.render.Event = function(
/** /**
* @type {ol.render.IVectorContext|undefined} * @type {ol.render.IVectorContext|undefined}
* @todo api
*/ */
this.vectorContext = opt_vectorContext; this.vectorContext = opt_vectorContext;
/** /**
* @type {olx.FrameState|undefined} * @type {olx.FrameState|undefined}
* @todo api
*/ */
this.frameState = opt_frameState; this.frameState = opt_frameState;
@@ -59,6 +61,7 @@ ol.render.Event = function(
* Canvas context. Only available when a Canvas renderer is used, * Canvas context. Only available when a Canvas renderer is used,
* null otherwise. * null otherwise.
* @type {CanvasRenderingContext2D|null|undefined} * @type {CanvasRenderingContext2D|null|undefined}
* @todo api
*/ */
this.context = opt_context; this.context = opt_context;
@@ -66,6 +69,7 @@ ol.render.Event = function(
* WebGL context. Only available when a WebGL renderer is used, null * WebGL context. Only available when a WebGL renderer is used, null
* otherwise. * otherwise.
* @type {ol.webgl.Context|null|undefined} * @type {ol.webgl.Context|null|undefined}
* @todo api
*/ */
this.glContext = opt_glContext; this.glContext = opt_glContext;

View File

@@ -404,6 +404,7 @@ ol.source.VectorEvent = function(type, opt_feature) {
/** /**
* The feature being added or removed. * The feature being added or removed.
* @type {ol.Feature|undefined} * @type {ol.Feature|undefined}
* @todo api
*/ */
this.feature = opt_feature; this.feature = opt_feature;