aboutsummaryrefslogtreecommitdiff
path: root/src/lib/defs
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2018-07-01 20:22:55 -0400
committerNick Mathewson <nickm@torproject.org>2018-07-01 20:22:55 -0400
commitcb1a3674ebb3826d9e1e56146210bd79cb4a42f0 (patch)
tree84382a222e7d271efb8426560b61fb1a28ec4e05 /src/lib/defs
parent83a4946e7b9d2bb75ab8dfa8073c5dd7b3f77bc9 (diff)
downloadtor-cb1a3674ebb3826d9e1e56146210bd79cb4a42f0.tar.gz
tor-cb1a3674ebb3826d9e1e56146210bd79cb4a42f0.zip
File-level documentation for some of src/lib.
Diffstat (limited to 'src/lib/defs')
-rw-r--r--src/lib/defs/digest_sizes.h9
1 files changed, 9 insertions, 0 deletions
diff --git a/src/lib/defs/digest_sizes.h b/src/lib/defs/digest_sizes.h
index f426fff20d..dd772cae07 100644
--- a/src/lib/defs/digest_sizes.h
+++ b/src/lib/defs/digest_sizes.h
@@ -7,6 +7,15 @@
#ifndef TOR_DIGEST_SIZES_H
#define TOR_DIGEST_SIZES_H
+/**
+ * \file digest_sizes.h
+ *
+ * \brief Definitions for common sizes of cryptographic digests.
+ *
+ * Tor uses digests throughout its codebase, even in parts that don't actually
+ * calculate the digests.
+ **/
+
/** Length of the output of our message digest. */
#define DIGEST_LEN 20
/** Length of the output of our second (improved) message digests. (For now