protocol: input documentation fixes
authorPeter Hutterer <peter.hutterer@who-t.net>
Thu, 4 Apr 2013 01:06:02 +0000 (11:06 +1000)
committerKristian Høgsberg <krh@bitplanet.net>
Thu, 4 Apr 2013 20:40:12 +0000 (16:40 -0400)
Fix summary for wl_touch::motion, extend summary for wl_touch::down to match
up/motion a bit better.

Fix a typo in wl_touch, and claim that it's zero or more update events, not
one or more.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
protocol/wayland.xml

index 45a3298..eda9441 100644 (file)
 
       Touch interactions can consist of one or more contacts.
       For each contact, a series of events is generated, starting
-      with a down event, followed by one or more motion events,
-      and ended with an up event. Events relating to the same
+      with a down event, followed by zero or more motion events,
+      and ending with an up event. Events relating to the same
       contact point can be identified by the ID of the sequence.
     </description>
 
     <event name="down">
-      <description summary="touch down event">
+      <description summary="touch down event and beginning of a touch sequence">
        A new touch point has appeared on the surface. This touch point is
        assigned a unique @id. Future events from this touchpoint reference
        this ID. The ID ceases to be valid after a touch up event and may be
     </event>
 
     <event name="motion">
-      <description summary="end of a touch event sequence">
+      <description summary="update of touch point coordinates">
        A touchpoint has changed coordinates.
       </description>
       <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>