diff --git a/docs/html/clock_8hh_source.html b/docs/html/clock_8hh_source.html index a5555b3..4c82877 100644 --- a/docs/html/clock_8hh_source.html +++ b/docs/html/clock_8hh_source.html @@ -78,43 +78,38 @@ $(function() {
7 
8  /* network time protocol */
9  namespace ntp {
-
10  uint64_t now();
-
11 
-
12  /* return the difference of ntp timestamps in milliseconds */
-
13  uint64_t diff(uint64_t ntp1, uint64_t ntp2);
-
14 
-
15  /* Calculate the difference between now
-
16  * (a wall clock reading when the function is called) and "then"
-
17  *
-
18  * The result is in milliseconds */
-
19  uint64_t diff_now(uint64_t then);
-
20  };
-
21 
-
22  /* high-resolution clock */
-
23  namespace hrc {
-
24  typedef std::chrono::high_resolution_clock::time_point hrc_t;
-
25 
-
26  hrc_t now();
-
27 
-
28  /* the result is in milliseconds */
-
29  uint64_t diff(hrc_t hrc1, hrc_t hrc2);
-
30 
-
31  /* the result is in milliseconds */
-
32  uint64_t diff_now(hrc_t then);
-
33 
-
34  uint64_t diff_now_us(hrc_t& then);
-
35  };
-
36 
-
37  uint64_t ms_to_jiffies(uint64_t ms);
-
38  uint64_t jiffies_to_ms(uint64_t jiffies);
-
39 
-
40 #ifdef _WIN32
-
41  int gettimeofday(struct timeval *tp, struct timezone *tzp);
-
42 #endif
-
43  };
-
44 };
-
45 
-
46 namespace uvg_rtp = uvgrtp;
+
15  uint64_t now();
+
16 
+
27  uint64_t diff(uint64_t ntp1, uint64_t ntp2);
+
28 
+
39  uint64_t diff_now(uint64_t then);
+
40  };
+
41 
+
43  /* high-resolution clock */
+
44  namespace hrc {
+
45  typedef std::chrono::high_resolution_clock::time_point hrc_t;
+
46 
+
47  hrc_t now();
+
48 
+
49  /* the result is in milliseconds */
+
50  uint64_t diff(hrc_t hrc1, hrc_t hrc2);
+
51 
+
52  /* the result is in milliseconds */
+
53  uint64_t diff_now(hrc_t then);
+
54 
+
55  uint64_t diff_now_us(hrc_t& then);
+
56  };
+
57 
+
58  uint64_t ms_to_jiffies(uint64_t ms);
+
59  uint64_t jiffies_to_ms(uint64_t jiffies);
+
60 
+
61 #ifdef _WIN32
+
62  int gettimeofday(struct timeval *tp, struct timezone *tzp);
+
63 #endif
+
65  };
+
66 };
+
67 
+
68 namespace uvg_rtp = uvgrtp;
diff --git a/include/clock.hh b/include/clock.hh index 3ea2378..d2767b7 100644 --- a/include/clock.hh +++ b/include/clock.hh @@ -7,18 +7,39 @@ namespace uvgrtp { /* network time protocol */ namespace ntp { + /** + * \brief Get current time in NTP units + * + * \return NTP timestamp + */ uint64_t now(); - /* return the difference of ntp timestamps in milliseconds */ + /** + * \brief Calculate the time difference of two NTP times + * + * The second timestamp is subtracted from the first one + * + * \param ntp1 First NTP timestamp + * \param ntp2 Second NTP timestamp + * + * \return Difference of the timestamps in milliseconds + */ uint64_t diff(uint64_t ntp1, uint64_t ntp2); - /* Calculate the difference between now - * (a wall clock reading when the function is called) and "then" + /** + * \brief Calculate the time difference of two NTP times * - * The result is in milliseconds */ + * \details This function calls uvgrtp::clock::ntp::now() + * and then subtracts the input parameter from that timestamp value. + * + * \param then NTP timestamp + * + * \return Difference of the timestamps in milliseconds + */ uint64_t diff_now(uint64_t then); }; + /// \cond DO_NOT_DOCUMENT /* high-resolution clock */ namespace hrc { typedef std::chrono::high_resolution_clock::time_point hrc_t; @@ -40,6 +61,7 @@ namespace uvgrtp { #ifdef _WIN32 int gettimeofday(struct timeval *tp, struct timezone *tzp); #endif + /// \endcond }; };