diff --git a/lib/OpenLayers/Events.js b/lib/OpenLayers/Events.js index 405c4b0031..9ac1de2e0c 100644 --- a/lib/OpenLayers/Events.js +++ b/lib/OpenLayers/Events.js @@ -379,7 +379,7 @@ OpenLayers.Events.prototype = { eventHandler: null, /** - * Property: fallThrough + * APIProperty: fallThrough * {Boolean} */ fallThrough: null, @@ -393,7 +393,7 @@ OpenLayers.Events.prototype = { * added element - {DOMElement} A dom element to respond to browser events * eventTypes - {Array} Array of custom application events * fallThrough - {Boolean} Allow events to fall through after these have - * been handled? + * been handled? */ initialize: function (object, element, eventTypes, fallThrough) { this.object = object; @@ -422,7 +422,7 @@ OpenLayers.Events.prototype = { }, /** - * Method: destroy + * APIMethod: destroy */ destroy: function () { if (this.element) { @@ -461,7 +461,7 @@ OpenLayers.Events.prototype = { }, /** - * Method: register + * APIMethod: register * Register an event on the events object. * * When the event is triggered, the 'func' function will be called, in the @@ -501,18 +501,21 @@ OpenLayers.Events.prototype = { }, /** - * TODO: get rid of this in 3.0 - Decide whether listeners should be - * called in the order they were registered or in reverse order. + * APIMethod: registerPriority + * Same as register() but adds the new listener to the *front* of the + * events queue instead of to the end. + * + * TODO: get rid of this in 3.0 - Decide whether listeners should be + * called in the order they were registered or in reverse order. * - * Method: registerPriority * * Parameters: * type - {String} Name of the event to register * obj - {Object} The object to bind the context to for the callback#. - * If no object is specified, default is the Events's - * 'object' property. + * If no object is specified, default is the Events's + * 'object' property. * func - {Function} The callback function. If no callback is - * specified, this function does nothing. + * specified, this function does nothing. */ registerPriority: function (type, obj, func) { @@ -528,7 +531,7 @@ OpenLayers.Events.prototype = { }, /** - * Method: unregister + * APIMethod: unregister * * Parameters: * type - {String} @@ -553,7 +556,7 @@ OpenLayers.Events.prototype = { /** * Method: remove * Remove all listeners for a given event type. If type is not registered, - * does nothing. + * does nothing. * * Parameters: * type - {String} @@ -565,7 +568,7 @@ OpenLayers.Events.prototype = { }, /** - * Method: triggerEvent + * APIMethod: triggerEvent * Trigger a specified registered event * * Parameters: @@ -612,8 +615,8 @@ OpenLayers.Events.prototype = { /** * Method: handleBrowserEvent * Basically just a wrapper to the triggerEvent() function, but takes - * care to set a property 'xy' on the event with the current mouse - * position. + * care to set a property 'xy' on the event with the current mouse + * position. * * Parameters: * evt - {Event} @@ -631,7 +634,7 @@ OpenLayers.Events.prototype = { * * Returns * {} The current xy coordinate of the mouse, adjusted - * for offsets + * for offsets */ getMousePosition: function (evt) { if (!this.element.offsets) {