Merge pull request #1898 from ahocevar/events

Document events

src/ol/mapbrowserevent.js

@@ -41,16 +41,19 @@ ol.MapBrowserEvent = function(type, map, browserEvent, opt_frameState) {
   /**
    * @const
    * @type {Event}
+   * @todo stability experimental
    */
   this.originalEvent = browserEvent.getBrowserEvent();
 
   /**
    * @type {ol.Coordinate}
+   * @todo stability experimental
    */
   this.coordinate = map.getEventCoordinate(this.originalEvent);
 
   /**
    * @type {ol.Pixel}
+   * @todo stability experimental
    */
   this.pixel = map.getEventPixel(this.originalEvent);
 
@@ -460,11 +463,32 @@ ol.MapBrowserEventHandler.prototype.disposeInternal = function() {
  */
 ol.MapBrowserEvent.EventType = {
   // derived event types
+  /**
+   * A true single click with no dragging and no double click. Note that this
+   * event is delayed by 250 ms to ensure that it is not a double click.
+   * @event ol.MapBrowserEvent#singleclick
+   * @todo stability experimental
+   */
   SINGLECLICK: 'singleclick',
+  /**
+   * A true double click, with no dragging.
+   * @event ol.MapBrowserEvent#dblclick
+   * @todo stability experimental
+   */
   DBLCLICK: goog.events.EventType.DBLCLICK,
+  /**
+   * Triggered when a pointer is dragged.
+   * @event ol.MapBrowserEvent#pointerdrag
+   * @todo stability experimental
+   */
   POINTERDRAG: 'pointerdrag',
 
   // original pointer event types
+  /**
+   * Triggered when a pointer is moved.
+   * @event ol.MapBrowserEvent#pointermove
+   * @todo stability experimental
+   */
   POINTERMOVE: 'pointermove',
   POINTERDOWN: 'pointerdown',
   POINTERUP: 'pointerup',