diff --git a/apidoc/conf.json b/apidoc/conf.json index 42c9f657d7..8131a4bc6e 100644 --- a/apidoc/conf.json +++ b/apidoc/conf.json @@ -21,7 +21,6 @@ "apidoc/plugins/inheritdoc", "apidoc/plugins/exports", "apidoc/plugins/todo", - "apidoc/plugins/event", "apidoc/plugins/observable", "apidoc/plugins/stability" ], diff --git a/apidoc/plugins/event.js b/apidoc/plugins/event.js deleted file mode 100644 index f1375f9a41..0000000000 --- a/apidoc/plugins/event.js +++ /dev/null @@ -1,18 +0,0 @@ -var util = require('util'); -exports.defineTags = function(dictionary) { - dictionary.defineTag('event', { - mustHaveValue: true, - canHaveType: false, - canHaveName: true, - onTagged: function(doclet, tag) { - var parts = tag.text.split(' '); - if (!doclet.events) { - doclet.events = []; - } - doclet.events.push({ - name: tag.value.name, - description: parts.slice(1).join(' ') - }); - } - }); -}; diff --git a/apidoc/plugins/observable.js b/apidoc/plugins/observable.js index 14bf45a722..772de2c7d4 100644 --- a/apidoc/plugins/observable.js +++ b/apidoc/plugins/observable.js @@ -21,6 +21,12 @@ exports.defineTags = function(dictionary) { description: description, readonly: readonly }); + if (!doclet.fires) { + doclet.fires = []; + } + if (doclet.fires.indexOf('{@link ol.ObjectEvent} ol.event:ObjectEvent') === -1) { + doclet.fires.push('{@link ol.ObjectEvent} ol.event:ObjectEvent'); + } } }); }; diff --git a/apidoc/plugins/todo.js b/apidoc/plugins/todo.js index 78faccb817..2a2d05a027 100644 --- a/apidoc/plugins/todo.js +++ b/apidoc/plugins/todo.js @@ -22,14 +22,12 @@ exports.defineTags = function(dictionary) { description: description, readonly: readonly }); - } else if (parts[0] === 'event') { - if (!doclet.events) { - doclet.events = []; + if (!doclet.fires) { + doclet.fires = []; + } + if (doclet.fires.indexOf('{@link ol.ObjectEvent} ol.event:ObjectEvent') === -1) { + doclet.fires.push('{@link ol.ObjectEvent} ol.event:ObjectEvent'); } - doclet.events.push({ - name: parts[1], - description: parts.slice(2).join(' ') - }); } } }); diff --git a/apidoc/template/tmpl/events.tmpl b/apidoc/template/tmpl/events.tmpl deleted file mode 100644 index d93bc97110..0000000000 --- a/apidoc/template/tmpl/events.tmpl +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - - - - - - - - - - - -
NameDescription
diff --git a/build.py b/build.py index 97c1b29dc4..24f9eb0bdd 100755 --- a/build.py +++ b/build.py @@ -373,7 +373,7 @@ virtual('lint', 'build/lint-timestamp', 'build/lint-generated-timestamp', def build_lint_src_timestamp(t): t.run('%(GJSLINT)s', '--jslint_error=all', - '--custom_jsdoc_tags=event,todo,function', + '--custom_jsdoc_tags=event,fires,todo,function', '--strict', t.newer(t.dependencies)) t.touch() diff --git a/src/ol/map.js b/src/ol/map.js index 7ff7b1e724..11d7c9da49 100644 --- a/src/ol/map.js +++ b/src/ol/map.js @@ -153,14 +153,11 @@ ol.MapProperty = { * The above snippet creates a map with a MapQuest OSM layer on a 2D view and * renders it to a DOM element with the id `map`. * - * In addition to the events listed below, the map relays - * {@link ol.MapBrowserEvent} events. - * * @constructor * @extends {ol.Object} * @param {olx.MapOptions} options Map options. - * @event moveend Triggered after the map is moved. - * @event postrender Triggered after a map frame is rendered. + * @fires {@link ol.MapEvent} ol.MapEvent + * @fires {@link ol.MapBrowserEvent} ol.MapBrowserEvent * @todo stability experimental * @todo observable layergroup {ol.layer.LayerGroup} a layer group containing * the layers in this map. diff --git a/src/ol/mapbrowserevent.js b/src/ol/mapbrowserevent.js index cc6db482ca..60c7235601 100644 --- a/src/ol/mapbrowserevent.js +++ b/src/ol/mapbrowserevent.js @@ -26,19 +26,6 @@ goog.require('ol.pointer.PointerEventHandler'); * @param {ol.Map} map Map. * @param {goog.events.BrowserEvent} browserEvent Browser event. * @param {?oli.FrameState=} opt_frameState Frame state. - * @event singleclick 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 dblclick A true double click, with no dragging. - * @event pointerdrag Triggered when a pointer is dragged. - * @event pointermove Triggered when a pointer is moved. - * @event pointerdown Triggered on pointer down. - * @event pointerup Triggered on pointer up. - * @event pointerover Triggered when a pointer is over the map's `target`. - * @event pointerout Triggered when a pointer is outside the map's `target`. - * @event pointerenter Triggered when a pointer enters the map's `target`. - * @event pointerleave Triggered when a pointer leaves the map's `target`. - * @event pointercancel Triggered when a pointer is no longer registered. * @todo stability experimental */ ol.MapBrowserEvent = function(type, map, browserEvent, opt_frameState) { @@ -473,11 +460,28 @@ 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 + */ SINGLECLICK: 'singleclick', + /** + * A true double click, with no dragging. + * @event ol.MapBrowserEvent#dblclick + */ DBLCLICK: goog.events.EventType.DBLCLICK, + /** + * Triggered when a pointer is dragged. + * @event ol.MapBrowserEvent#pointerdrag + */ POINTERDRAG: 'pointerdrag', // original pointer event types + /** + * Triggered when a pointer is moved. + * @event ol.MapBrowserEvent#pointermove + */ POINTERMOVE: 'pointermove', POINTERDOWN: 'pointerdown', POINTERUP: 'pointerup', @@ -487,3 +491,4 @@ ol.MapBrowserEvent.EventType = { POINTERLEAVE: 'pointerleave', POINTERCANCEL: 'pointercancel' }; +