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

6 files changed, 30 insertions, 0 deletions

diff --git a/src/lib/log/escape.c b/src/lib/log/escape.c
index 7561710309..b6b20183ba 100644
--- a/src/lib/log/escape.c
+++ b/src/lib/log/escape.c
@@ -3,6 +3,11 @@
  * Copyright (c) 2007-2018, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * \file escape.c
+ * \brief Escape untrusted strings before sending them to the log.
+ **/
+
 #include "lib/log/escape.h"
 #include "lib/log/util_bug.h"
 #include "lib/string/compat_ctype.h"
diff --git a/src/lib/log/escape.h b/src/lib/log/escape.h
index 5d2e79d6c2..f47e7e004d 100644
--- a/src/lib/log/escape.h
+++ b/src/lib/log/escape.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2018, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * \file escape.h
+ * \brief Header for escape.c
+ **/
+
 #ifndef TOR_ESCAPE_H
 #define TOR_ESCAPE_H
 
diff --git a/src/lib/log/ratelim.c b/src/lib/log/ratelim.c
index 677c499110..fba702d7f0 100644
--- a/src/lib/log/ratelim.c
+++ b/src/lib/log/ratelim.c
@@ -3,6 +3,11 @@
  * Copyright (c) 2007-2018, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * \file ratelim.c
+ * \brief Summarize similar messages that would otherwise flood the logs.
+ **/
+
 #include "lib/log/ratelim.h"
 #include "lib/malloc/util_malloc.h"
 #include "lib/string/printf.h"
diff --git a/src/lib/log/ratelim.h b/src/lib/log/ratelim.h
index 4ee6c5fed4..d423e10b85 100644
--- a/src/lib/log/ratelim.h
+++ b/src/lib/log/ratelim.h
@@ -3,6 +3,11 @@
  * Copyright (c) 2007-2018, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * \file ratelim.h
+ * \brief Summarize similar messages that would otherwise flood the logs.
+ **/
+
 #ifndef TOR_RATELIM_H
 #define TOR_RATELIM_H
 
diff --git a/src/lib/log/win32err.c b/src/lib/log/win32err.c
index 4586c23c84..6603ed4648 100644
--- a/src/lib/log/win32err.c
+++ b/src/lib/log/win32err.c
@@ -3,6 +3,11 @@
  * Copyright (c) 2007-2018, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * \file win32err.c
+ * \brief Convert windows error codes to useful C strings.
+ **/
+
 #ifdef _WIN32
 #include "orconfig.h"
 #include "lib/log/win32err.h"
diff --git a/src/lib/log/win32err.h b/src/lib/log/win32err.h
index 61d3af57dd..92958c9879 100644
--- a/src/lib/log/win32err.h
+++ b/src/lib/log/win32err.h
@@ -3,6 +3,11 @@
  * Copyright (c) 2007-2018, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * \file win32err.h
+ * \brief Header for win32err.c
+ **/
+
 #ifndef TOR_WIN32ERR_H
 #define TOR_WIN32ERR_H