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

12 files changed, 61 insertions, 0 deletions

diff --git a/src/lib/string/compat_ctype.c b/src/lib/string/compat_ctype.c
index d1d4ce0ffc..35f4ec6534 100644
--- a/src/lib/string/compat_ctype.c
+++ b/src/lib/string/compat_ctype.c
@@ -3,6 +3,11 @@
  * Copyright (c) 2007-2018, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * \file compat_ctype.c
+ * \brief Locale-independent character-type inspection (backend)
+ **/
+
 #include "lib/string/compat_ctype.h"
 
 /**
diff --git a/src/lib/string/compat_ctype.h b/src/lib/string/compat_ctype.h
index 530a10270f..210c460c31 100644
--- a/src/lib/string/compat_ctype.h
+++ b/src/lib/string/compat_ctype.h
@@ -3,6 +3,11 @@
  * Copyright (c) 2007-2018, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * \file compat_ctype.h
+ * \brief Locale-independent character-type inspection (header)
+ **/
+
 #ifndef TOR_COMPAT_CTYPE_H
 #define TOR_COMPAT_CTYPE_H
 
diff --git a/src/lib/string/compat_string.c b/src/lib/string/compat_string.c
index 8b063b7242..eae82fdae0 100644
--- a/src/lib/string/compat_string.c
+++ b/src/lib/string/compat_string.c
@@ -3,6 +3,12 @@
  * Copyright (c) 2007-2018, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * \file compat_string.c
+ * \brief Useful string-processing functions that some platforms don't
+ * provide.
+ **/
+
 #include "lib/string/compat_string.h"
 #include "lib/err/torerr.h"
 
diff --git a/src/lib/string/compat_string.h b/src/lib/string/compat_string.h
index 4726d2b5b6..9292717337 100644
--- a/src/lib/string/compat_string.h
+++ b/src/lib/string/compat_string.h
@@ -3,6 +3,11 @@
  * Copyright (c) 2007-2018, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * \file compat_string.h
+ * \brief Header for compat_string.c
+ **/
+
 #ifndef TOR_COMPAT_STRING_H
 #define TOR_COMPAT_STRING_H
 
diff --git a/src/lib/string/parse_int.c b/src/lib/string/parse_int.c
index e552730cc4..52ff49ef1e 100644
--- a/src/lib/string/parse_int.c
+++ b/src/lib/string/parse_int.c
@@ -3,6 +3,11 @@
  * Copyright (c) 2007-2018, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * \file parse_int.c
+ * \brief Convert strings into the integers they encode, with bounds checking.
+ **/
+
 #include "lib/string/parse_int.h"
 
 #include <errno.h>
diff --git a/src/lib/string/parse_int.h b/src/lib/string/parse_int.h
index 6f56fc32a8..663a5acd74 100644
--- a/src/lib/string/parse_int.h
+++ b/src/lib/string/parse_int.h
@@ -3,6 +3,11 @@
  * Copyright (c) 2007-2018, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * \file parse_int.h
+ * \brief Header for parse_int.c
+ **/
+
 #ifndef TOR_PARSE_INT_H
 #define TOR_PARSE_INT_H
 
diff --git a/src/lib/string/printf.c b/src/lib/string/printf.c
index 4443e25fb4..f8be3b4704 100644
--- a/src/lib/string/printf.c
+++ b/src/lib/string/printf.c
@@ -3,6 +3,11 @@
  * Copyright (c) 2007-2018, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * \file printf.c
+ * \brief Compatibility wrappers around snprintf and its friends
+ **/
+
 #include "lib/string/printf.h"
 #include "lib/err/torerr.h"
 #include "lib/cc/torint.h"
diff --git a/src/lib/string/printf.h b/src/lib/string/printf.h
index 69b724379a..49c37d43e0 100644
--- a/src/lib/string/printf.h
+++ b/src/lib/string/printf.h
@@ -3,6 +3,11 @@
  * Copyright (c) 2007-2018, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * \file printf.h
+ * \brief Header for printf.c
+ **/
+
 #ifndef TOR_UTIL_PRINTF_H
 #define TOR_UTIL_PRINTF_H
 
diff --git a/src/lib/string/scanf.c b/src/lib/string/scanf.c
index 0c5082799c..7b08442148 100644
--- a/src/lib/string/scanf.c
+++ b/src/lib/string/scanf.c
@@ -3,6 +3,11 @@
  * Copyright (c) 2007-2018, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * \file scanf.c
+ * \brief Locale-independent minimal implementation of sscanf().
+ **/
+
 #include "lib/string/scanf.h"
 #include "lib/string/compat_ctype.h"
 #include "lib/cc/torint.h"
diff --git a/src/lib/string/scanf.h b/src/lib/string/scanf.h
index 9cfa9cc6c1..ada2322bb1 100644
--- a/src/lib/string/scanf.h
+++ b/src/lib/string/scanf.h
@@ -3,6 +3,11 @@
  * Copyright (c) 2007-2018, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * \file scanf.h
+ * \brief Header for scanf.c
+ **/
+
 #ifndef TOR_UTIL_SCANF_H
 #define TOR_UTIL_SCANF_H
 
diff --git a/src/lib/string/util_string.c b/src/lib/string/util_string.c
index e8ed3d4f54..a6b0a3d68a 100644
--- a/src/lib/string/util_string.c
+++ b/src/lib/string/util_string.c
@@ -3,6 +3,11 @@
  * Copyright (c) 2007-2018, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * \file util_string.c
+ * \brief Non-standard string functions used throughout Tor.
+ **/
+
 #include "lib/string/util_string.h"
 #include "lib/string/compat_ctype.h"
 #include "lib/err/torerr.h"
diff --git a/src/lib/string/util_string.h b/src/lib/string/util_string.h
index 75407d5ffa..471613462a 100644
--- a/src/lib/string/util_string.h
+++ b/src/lib/string/util_string.h
@@ -3,6 +3,11 @@
  * Copyright (c) 2007-2018, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * \file util_string.h
+ * \brief Header for util_string.c
+ **/
+
 #ifndef TOR_UTIL_STRING_H
 #define TOR_UTIL_STRING_H