Merge lp:~dandrader/geis/doc_touch_defines into lp:geis

[Daniel d'Andrada]

Document GEIS_GESTURE_ATTRIBUTE_TOUCH_N_[ID|X|Y] definitions

Mostly to make clear they are used only by GEIS v1 API

[Stephen M. Webb (bregma)]

The preposition used with the noun 'index' is usually 'at', as in 'at index 0'. If you could change that, I approve of this (but get it in quicky, I want to do a final release into 12.04).

review: Approve

=== modified file 'include/geis/geis.h'
--- include/geis/geis.h	2012-03-27 21:39:04 +0000
+++ include/geis/geis.h	2012-04-12 16:07:19 +0000
@@ -271,6 +271,66 @@
  * This attribute provides the Y coordinate of the position of a gesture, in
  * device coordinates. It's the same as the centroid of a gesture. See
  * GEIS_GESTURE_ATTRIBUTE_CENTROID_Y.
+ *
+ * @def GEIS_GESTURE_ATTRIBUTE_TOUCH_0_ID
+ * This attribute provides the ID of the touch of index 0.
+ * Only used by GEIS v1 API.
+ *
+ * @def GEIS_GESTURE_ATTRIBUTE_TOUCH_0_X
+ * This attribute provides the X coordinate of the touch of index 0.
+ * Only used by GEIS v1 API.
+ *
+ * @def GEIS_GESTURE_ATTRIBUTE_TOUCH_0_Y
+ * This attribute provides the Y coordinate of the touch of index 0.
+ * Only used by GEIS v1 API.
+ *
+ * @def GEIS_GESTURE_ATTRIBUTE_TOUCH_1_ID
+ * This attribute provides the ID of the touch of index 1.
+ * Only used by GEIS v1 API.
+ *
+ * @def GEIS_GESTURE_ATTRIBUTE_TOUCH_1_X
+ * This attribute provides the X coordinate of the touch of index 1.
+ * Only used by GEIS v1 API.
+ *
+ * @def GEIS_GESTURE_ATTRIBUTE_TOUCH_1_Y
+ * This attribute provides the Y coordinate of the touch of index 1.
+ * Only used by GEIS v1 API.
+ *
+ * @def GEIS_GESTURE_ATTRIBUTE_TOUCH_2_ID
+ * This attribute provides the ID of the touch of index 2.
+ * Only used by GEIS v1 API.
+ *
+ * @def GEIS_GESTURE_ATTRIBUTE_TOUCH_2_X
+ * This attribute provides the X coordinate of the touch of index 2.
+ * Only used by GEIS v1 API.
+ *
+ * @def GEIS_GESTURE_ATTRIBUTE_TOUCH_2_Y
+ * This attribute provides the Y coordinate of the touch of index 2.
+ * Only used by GEIS v1 API.
+ *
+ * @def GEIS_GESTURE_ATTRIBUTE_TOUCH_3_ID
+ * This attribute provides the ID of the touch of index 3.
+ * Only used by GEIS v1 API.
+ *
+ * @def GEIS_GESTURE_ATTRIBUTE_TOUCH_3_X
+ * This attribute provides the X coordinate of the touch of index 3.
+ * Only used by GEIS v1 API.
+ *
+ * @def GEIS_GESTURE_ATTRIBUTE_TOUCH_3_Y
+ * This attribute provides the Y coordinate of the touch of index 3.
+ * Only used by GEIS v1 API.
+ *
+ * @def GEIS_GESTURE_ATTRIBUTE_TOUCH_4_ID
+ * This attribute provides the ID of the touch of index 4.
+ * Only used by GEIS v1 API.
+ *
+ * @def GEIS_GESTURE_ATTRIBUTE_TOUCH_4_X
+ * This attribute provides the X coordinate of the touch of index 4.
+ * Only used by GEIS v1 API.
+ *
+ * @def GEIS_GESTURE_ATTRIBUTE_TOUCH_4_Y
+ * This attribute provides the Y coordinate of the touch of index 4.
+ * Only used by GEIS v1 API.
  */
 #define GEIS_GESTURE_ATTRIBUTE_ANGLE            "angle"
 #define GEIS_GESTURE_ATTRIBUTE_ANGLE_DELTA      "angle delta"