From 31ee6a19663455c0081e91ed105e5eaed9c1882b Mon Sep 17 00:00:00 2001
From: Ryan Pavlik <ryan.pavlik@collabora.com>
Date: Mon, 2 Mar 2020 13:59:06 -0600
Subject: [PATCH] os/time: Documentation.

---
 src/xrt/auxiliary/os/os_time.h | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/xrt/auxiliary/os/os_time.h b/src/xrt/auxiliary/os/os_time.h
index 9e83ed21a..1b6383873 100644
--- a/src/xrt/auxiliary/os/os_time.h
+++ b/src/xrt/auxiliary/os/os_time.h
@@ -3,6 +3,11 @@
 /*!
  * @file
  * @brief  Wrapper around OS native time functions.
+ *
+ * These should be preferred over directly using native OS time functions in
+ * potentially-portable code. Additionally, in most cases these are preferred
+ * over timepoints from @ref time_state for general usage in drivers, etc.
+ *
  * @author Drew DeVault <sir@cmpwn.com>
  * @author Jakob Bornecrantz <jakob@collabora.com>
  *