docs: Document granularity of timestamps
authorMatthias Clasen <mclasen@redhat.com>
Sat, 30 Mar 2013 18:09:24 +0000 (14:09 -0400)
committerKristian Høgsberg <krh@bitplanet.net>
Tue, 2 Apr 2013 01:43:17 +0000 (21:43 -0400)
This information is necessary to make any use of these fields.

protocol/wayland.xml

index 899a686..6864779 100644 (file)
        is provided by the x an y arguments, in surface local
        coordinates.
       </description>
-      <arg name="time" type="uint"/>
+      <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
       <arg name="x" type="fixed"/>
       <arg name="y" type="fixed"/>
     </event>
        focused surface.
       </description>
 
-      <arg name="time" type="uint"/>
+      <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
       <arg name="surface_x" type="fixed"/>
       <arg name="surface_y" type="fixed"/>
     </event>
 
        The location of the click is given by the last motion or
        enter event.
+        The time argument is a timestamp with millisecond
+        granularity, with an undefined base.
       </description>
 
       <arg name="serial" type="uint"/>
-      <arg name="time" type="uint"/>
+      <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
       <arg name="button" type="uint"/>
       <arg name="state" type="uint"/>
     </event>
        scroll distance.
       </description>
 
-      <arg name="time" type="uint"/>
+      <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
       <arg name="axis" type="uint"/>
       <arg name="value" type="fixed"/>
     </event>
     <event name="key">
       <description summary="key event">
        A key was pressed or released.
+        The time argument is a timestamp with millisecond
+        granularity, with an undefined base.
       </description>
 
       <arg name="serial" type="uint"/>
-      <arg name="time" type="uint"/>
+      <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
       <arg name="key" type="uint"/>
       <arg name="state" type="uint"/>
     </event>
         of its surfaces.
       </description>
       <arg name="serial" type="uint"/>
-      <arg name="time" type="uint"/>
+      <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
       <arg name="surface" type="object" interface="wl_surface"/>
       <arg name="id" type="int" summary="ID of the touch sequence"/>
       <arg name="x" type="fixed"/>
         Notifies the client that a touch has ended.
       </description>
       <arg name="serial" type="uint"/>
-      <arg name="time" type="uint"/>
+      <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
       <arg name="id" type="int"/>
     </event>
 
         Notifies the client that the position of a contact point
         has changed.
       </description>
-      <arg name="time" type="uint"/>
+      <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
       <arg name="id" type="int" summary="ID of the touch sequence"/>
       <arg name="x" type="fixed"/>
       <arg name="y" type="fixed"/>