[libmanette] event: Improve the documentation of *_get_time()



commit db63eb41653d58a99c4ebd05c2bca7d24c09e512
Author: vanadiae <vanadiae35 gmail com>
Date:   Wed Oct 14 20:12:18 2020 +0200

    event: Improve the documentation of *_get_time()
    
    This also explains why it's not a good idea to do timing difference
    between two events yourself.

 src/manette-event.c | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)
---
diff --git a/src/manette-event.c b/src/manette-event.c
index 8aea1dc..3afb021 100644
--- a/src/manette-event.c
+++ b/src/manette-event.c
@@ -106,9 +106,11 @@ manette_event_get_event_type (const ManetteEvent *self)
  * manette_event_get_time:
  * @self: a #ManetteEvent
  *
- * Gets the time stamp of @self.
+ * Gets the timestamp of when @self was received by the input driver that takes
+ * care of its device. Use this timestamp to ensure external factors such as
+ * synchronous disk writes don't influence your timing computations.
  *
- * Returns: the time stamp of @self
+ * Returns: the timestamp of when @self was received by the input driver
  */
 guint32
 manette_event_get_time (const ManetteEvent *self)


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]