File-level summary documentation for src/lib/*/*.[ch]

8 files changed, 35 insertions, 3 deletions

diff --git a/src/lib/wallclock/approx_time.c b/src/lib/wallclock/approx_time.c
index 2528954f13..bb9a292369 100644
--- a/src/lib/wallclock/approx_time.c
+++ b/src/lib/wallclock/approx_time.c
@@ -3,6 +3,11 @@
  * Copyright (c) 2007-2018, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * \file approx_time.c
+ * \brief Cache the last result of time(), for performance and testing.
+ **/
+
 #include "orconfig.h"
 #include "lib/wallclock/approx_time.h"
 
diff --git a/src/lib/wallclock/approx_time.h b/src/lib/wallclock/approx_time.h
index c57ff5bcd3..becc632fe3 100644
--- a/src/lib/wallclock/approx_time.h
+++ b/src/lib/wallclock/approx_time.h
@@ -3,6 +3,11 @@
  * Copyright (c) 2007-2018, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * \file approx_time.h
+ * \brief Header for approx_time.c
+ **/
+
 #ifndef TOR_APPROX_TIME_H
 #define TOR_APPROX_TIME_H
 
diff --git a/src/lib/wallclock/timeval.c b/src/lib/wallclock/timeval.c
deleted file mode 100644
index e69de29bb2..0000000000
--- a/src/lib/wallclock/timeval.c
+++ /dev/null
diff --git a/src/lib/wallclock/timeval.h b/src/lib/wallclock/timeval.h
index 6a9b36a022..b34277cda6 100644
--- a/src/lib/wallclock/timeval.h
+++ b/src/lib/wallclock/timeval.h
@@ -3,6 +3,13 @@
  * Copyright (c) 2007-2018, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * \file timeval.h
+ *
+ * \brief Declarations for timeval-related macros that some platforms
+ * are missing.
+ **/
+
 #ifndef TOR_TIMEVAL_H
 #define TOR_TIMEVAL_H
 
diff --git a/src/lib/wallclock/tm_cvt.c b/src/lib/wallclock/tm_cvt.c
index 31d929e635..4a51a4ab3a 100644
--- a/src/lib/wallclock/tm_cvt.c
+++ b/src/lib/wallclock/tm_cvt.c
@@ -3,6 +3,11 @@
  * Copyright (c) 2007-2018, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * \file tm_cvt.c
+ * \brief Convert to and from struct tm, portably.
+ **/
+
 #include "orconfig.h"
 #include "lib/cc/torint.h"
 #include "lib/cc/compat_compiler.h"
diff --git a/src/lib/wallclock/tm_cvt.h b/src/lib/wallclock/tm_cvt.h
index 4d87acd4fa..a1cdc80ef1 100644
--- a/src/lib/wallclock/tm_cvt.h
+++ b/src/lib/wallclock/tm_cvt.h
@@ -3,6 +3,11 @@
  * Copyright (c) 2007-2018, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * \file tm_cvt.h
+ * \brief Header for tm_cvt.c
+ **/
+
 #ifndef TOR_WALLCLOCK_TM_CVT_H
 #define TOR_WALLCLOCK_TM_CVT_H
 
diff --git a/src/lib/wallclock/tor_gettimeofday.c b/src/lib/wallclock/tor_gettimeofday.c
index eb902e681d..aefe796ad2 100644
--- a/src/lib/wallclock/tor_gettimeofday.c
+++ b/src/lib/wallclock/tor_gettimeofday.c
@@ -4,9 +4,9 @@
 /* See LICENSE for licensing information */
 
 /**
- * \file compat_time.c
- * \brief Portable wrappers for finding out the current time, running
- *   timers, etc.
+ * \file tor_gettimeofday.c
+ * \brief Implementat gettimeofday() for windows, and other platforms without
+ *   it.
  **/
 
 #include "orconfig.h"
diff --git a/src/lib/wallclock/tor_gettimeofday.h b/src/lib/wallclock/tor_gettimeofday.h
index 728ad9565d..aac6366a65 100644
--- a/src/lib/wallclock/tor_gettimeofday.h
+++ b/src/lib/wallclock/tor_gettimeofday.h
@@ -3,6 +3,11 @@
  * Copyright (c) 2007-2018, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * \file tor_gettimeofday.h
+ * \brief Header for tor_gettimeofday.c
+ **/
+
 #ifndef TOR_GETTIMEOFDAY_H
 #define TOR_GETTIMEOFDAY_H