clean/extend some module docs, including fix from #18403

diff --git a/src/common/backtrace.c b/src/common/backtrace.c
index eac54e0b694c9fc62e0df513577922f6d50d228c..3b762b68e39230455a4606a79931c1e8e281ab0b 100644 (file)
--- a/src/common/backtrace.c
+++ b/src/common/backtrace.c
@@ -6,6 +6,11 @@
  *
  * \brief Functions to produce backtraces on bugs, crashes, or assertion
  * failures.
+ *
+ * Currently, we've only got an implementation here using the backtrace()
+ * family of functions, which are sometimes provided by libc and sometimes
+ * provided by libexecinfo.  We tie into the sigaction() backend in order to
+ * detect crashes.
  */
 
 #define __USE_GNU

diff --git a/src/common/compat.c b/src/common/compat.c
index 6f3e1e680fe98f7be1b36668ac62d78252490dc9..af61f024ef64627fc6e0ed31137fd11c1ecc9778 100644 (file)
--- a/src/common/compat.c
+++ b/src/common/compat.c
@@ -6,7 +6,7 @@
 /**
  * \file compat.c
  * \brief Wrappers to make calls more portable.  This code defines
- * functions such as tor_malloc, tor_snprintf, get/set various data types,
+ * functions such as tor_snprintf, get/set various data types,
  * renaming, setting socket options, switching user IDs.  It is basically
  * where the non-portable items are conditionally included depending on
  * the platform.

diff --git a/src/common/crypto.c b/src/common/crypto.c
index b03162462bcbea4409f85ed6abfd81fa0a2c7e28..11f8e1db194b82931da84e344a98a664ab51837e 100644 (file)
--- a/src/common/crypto.c
+++ b/src/common/crypto.c
@@ -7,7 +7,8 @@
 /**
  * \file crypto.c
  * \brief Wrapper functions to present a consistent interface to
- * public-key and symmetric cryptography operations from OpenSSL.
+ * public-key and symmetric cryptography operations from OpenSSL and
+ * other places.
  **/
 
 #include "orconfig.h"