Add missing event documentation and stability tags

This commit is contained in:
ahocevar
2014-03-26 14:04:58 +01:00
parent 932cab12af
commit a3b5376520
24 changed files with 121 additions and 11 deletions
@@ -19,6 +19,8 @@ goog.require('ol.proj');
/**
* @constructor
* @extends {ol.interaction.Interaction}
* @fires {@link ol.interaction.DragAndDropEvent}
* ol.interaction.DragAndDropEvent
* @param {olx.interaction.DragAndDropOptions=} opt_options Options.
*/
ol.interaction.DragAndDrop = function(opt_options) {
@@ -175,6 +177,11 @@ ol.interaction.DragAndDrop.prototype.tryReadFeatures_ = function(format, text) {
* @enum {string}
*/
ol.interaction.DragAndDropEventType = {
/**
* Triggered when features are added
* @event ol.interaction.DragAndDropEvent#addfeatures
* @todo stability experimental
*/
ADD_FEATURES: 'addfeatures'
};
@@ -196,11 +203,13 @@ ol.interaction.DragAndDropEvent =
/**
* @type {Array.<ol.Feature>|undefined}
* @todo stability experimental
*/
this.features = opt_features;
/**
* @type {ol.proj.Projection|undefined}
* @todo stability experimental
*/
this.projection = opt_projection;
+11
View File
@@ -31,7 +31,17 @@ ol.DRAG_BOX_HYSTERESIS_PIXELS_SQUARED =
* @enum {string}
*/
ol.DragBoxEventType = {
/**
* Triggered upon drag box start.
* @event ol.DragBoxEvent#boxstart
* @todo stability experimental
*/
BOXSTART: 'boxstart',
/**
* Triggered upon drag box end.
* @event ol.DragBoxEvent#boxstart
* @todo stability experimental
*/
BOXEND: 'boxend'
};
@@ -70,6 +80,7 @@ goog.inherits(ol.DragBoxEvent, goog.events.Event);
*
* @constructor
* @extends {ol.interaction.Pointer}
* @fires {@link ol.DragBoxEvent} ol.DragBoxEvent
* @param {olx.interaction.DragBoxOptions=} opt_options Options.
* @todo stability experimental
*/
+13
View File
@@ -29,7 +29,17 @@ goog.require('ol.style.Style');
* @enum {string}
*/
ol.DrawEventType = {
/**
* Triggered upon feature draw start
* @event ol.DrawEvent#drawstart
* @todo stability experimental
*/
DRAWSTART: 'drawstart',
/**
* Triggered upon feature draw end
* @event ol.DrawEvent#drawend
* @todo stability experimental
*/
DRAWEND: 'drawend'
};
@@ -47,7 +57,9 @@ ol.DrawEvent = function(type, feature) {
goog.base(this, type);
/**
* The feature being drawn.
* @type {ol.Feature}
* @todo stability experimental
*/
this.feature = feature;
@@ -60,6 +72,7 @@ goog.inherits(ol.DrawEvent, goog.events.Event);
* Interaction that allows drawing geometries
* @constructor
* @extends {ol.interaction.Pointer}
* @fires {@link ol.DrawEvent} ol.DrawEvent
* @param {olx.interaction.DrawOptions} options Options.
* @todo stability experimental
*/