[OpenLayers-Commits] r3621 - trunk/openlayers/lib/OpenLayers

[commits at openlayers.org]

Author: euzuro
Date: 2007-07-06 13:47:38 -0400 (Fri, 06 Jul 2007)
New Revision: 3621

Modified:
   trunk/openlayers/lib/OpenLayers/Events.js
Log:
update nd docs for Openlayers.Events

Modified: trunk/openlayers/lib/OpenLayers/Events.js
===================================================================
--- trunk/openlayers/lib/OpenLayers/Events.js	2007-07-06 17:38:20 UTC (rev 3620)
+++ trunk/openlayers/lib/OpenLayers/Events.js	2007-07-06 17:47:38 UTC (rev 3621)
@@ -379,7 +379,7 @@
 	eventHandler: null,
 
     /** 
-	 * Property: fallThrough 
+	 * APIProperty: fallThrough 
 	 * {Boolean} 
 	 */
 	fallThrough: null,
@@ -393,7 +393,7 @@
      * 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 @@
     },
 
     /**
-     * Method: destroy
+     * APIMethod: destroy
      */
     destroy: function () {
         if (this.element) {
@@ -461,7 +461,7 @@
     },
 
     /**
-     * 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 @@
     },
 
     /**
-     *   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 @@
     },
     
     /**
-     * Method: unregister
+     * APIMethod: unregister
      *
      * Parameters:
      * type - {String} 
@@ -553,7 +556,7 @@
     /** 
      * 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 @@
     },
 
     /**
-     * Method: triggerEvent
+     * APIMethod: triggerEvent
      * Trigger a specified registered event
      * 
      * Parameters:
@@ -612,8 +615,8 @@
     /**
      * 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 @@
      * 
      * Returns 
      * {<OpenLayers.Pixel>} The current xy coordinate of the mouse, adjusted
-     * for offsets
+     *                      for offsets
      */
     getMousePosition: function (evt) {
         if (!this.element.offsets) {