From 67f51ad9723580b1c657d2492920d14b37d8a2c0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Lemoine?= Date: Wed, 10 Dec 2008 20:04:29 +0000 Subject: [PATCH] it was reported on the mailing list that the hover handler doc isn't sufficient, fix that, thanks for reporting this Mika, no functional change git-svn-id: http://svn.openlayers.org/trunk/openlayers@8484 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf --- lib/OpenLayers/Handler/Hover.js | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/lib/OpenLayers/Handler/Hover.js b/lib/OpenLayers/Handler/Hover.js index 28644ea6ab..38e5ce781d 100644 --- a/lib/OpenLayers/Handler/Hover.js +++ b/lib/OpenLayers/Handler/Hover.js @@ -34,21 +34,21 @@ OpenLayers.Handler.Hover = OpenLayers.Class(OpenLayers.Handler, { /** * APIProperty: stopMove - * {Boolean} Stop other listeners from being notified on mousemoves. + * {Boolean} - Stop other listeners from being notified on mousemoves. * Default is false. */ stopMove: false, /** * Property: px - * {} The location of the last mousemove, expressed + * {} - The location of the last mousemove, expressed * in pixels. */ px: null, /** * Property: timerId - * {Number} The id of the timer. + * {Number} - The id of the timer. */ timerId: null, @@ -60,10 +60,11 @@ OpenLayers.Handler.Hover = OpenLayers.Class(OpenLayers.Handler, { * control - {} The control that initialized this * handler. The control is assumed to have a valid map property; that * map is used in the handler's own setMap method. - * callbacks - {Object} An object whose properties correspond to abstracted - * events or sequences of browser events. The values for these - * properties are functions defined by the control that get called by - * the handler. + * callbacks - {Object} An object with keys corresponding to callbacks + * that will be called by the handler. The callbacks should + * expect to receive a single argument, the event. Callbacks for + * 'move', the mouse is moving, and 'pause', the mouse is pausing, + * are supported. * options - {Object} An optional object whose properties will be set on * the handler. */