[Bf-blender-cvs] [b5a9434] compositor-2016: Cleanup: Add comment on behavior of tweak events

[Julian Eisel]

Commit: b5a9434a29a19e214c2fee8427351392620f3762
Author: Julian Eisel
Date:   Tue Jun 7 23:10:53 2016 +0200
Branches: compositor-2016
https://developer.blender.org/rBb5a9434a29a19e214c2fee8427351392620f3762

Cleanup: Add comment on behavior of tweak events

It's not obvious that they use the mouse coordinate of the initial key-press event (behavior since rBf1f33ba7be2d), so added comment.

Also corrected other comments.

===================================================================

M	source/blender/windowmanager/wm_event_types.h

===================================================================

diff --git a/source/blender/windowmanager/wm_event_types.h b/source/blender/windowmanager/wm_event_types.h
index e2b95da..3085f13 100644
--- a/source/blender/windowmanager/wm_event_types.h
+++ b/source/blender/windowmanager/wm_event_types.h
@@ -311,14 +311,17 @@ enum {
 	TIMERNOTIFIER         = 0x0118,  /* timer event, notifier sender */
 	TIMERF                = 0x011F,  /* last timer */
 
-	/* Tweak, gestures: 0x500x, 0x501x */
+	/* Actionzones, tweak, gestures: 0x500x, 0x501x */
 	EVT_ACTIONZONE_AREA   = 0x5000,
 	EVT_ACTIONZONE_REGION = 0x5001,
 	EVT_ACTIONZONE_FULLSCREEN = 0x5011,
 
 	/* NOTE: these values are saved in keymap files, do not change them but just add new ones */
 
-	/* tweak events, for L M R mousebuttons */
+	/* Tweak events:
+	 * Sent as additional event with the mouse coordinates from where the initial click was placed. */
+
+	/* tweak events for L M R mousebuttons */
 	EVT_TWEAK_L           = 0x5002,
 	EVT_TWEAK_M           = 0x5003,
 	EVT_TWEAK_R           = 0x5004,