aboutsummaryrefslogtreecommitdiff
path: root/src/lib/crypt_ops
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2019-11-04 11:51:38 -0500
committerNick Mathewson <nickm@torproject.org>2019-11-04 11:51:38 -0500
commit76e8effc7b8e747cd34188a5a27e6d792a66ba7e (patch)
tree4f860630375bbed2e613f61c2c4473303be5451e /src/lib/crypt_ops
parentfd271363296b89cb3a11e97e507546b3600fde59 (diff)
downloadtor-76e8effc7b8e747cd34188a5a27e6d792a66ba7e.tar.gz
tor-76e8effc7b8e747cd34188a5a27e6d792a66ba7e.zip
Doxygen: document the rest of the directories in lib.
(This copies documentation from doc/HACKING/design, and edits for concisensess and clarity.)
Diffstat (limited to 'src/lib/crypt_ops')
-rw-r--r--src/lib/crypt_ops/lib_crypt_ops.dox10
1 files changed, 9 insertions, 1 deletions
diff --git a/src/lib/crypt_ops/lib_crypt_ops.dox b/src/lib/crypt_ops/lib_crypt_ops.dox
index 0c3e4d7c3f..d856d93be1 100644
--- a/src/lib/crypt_ops/lib_crypt_ops.dox
+++ b/src/lib/crypt_ops/lib_crypt_ops.dox
@@ -1,4 +1,12 @@
/**
@dir /lib/crypt_ops
-@brief lib/crypt_ops
+@brief lib/crypt_ops: Cryptographic operations.
+
+This module contains wrappers around the cryptographic libraries that we
+support, and implementations for some higher-level cryptographic
+constructions that we use.
+
+It wraps our two major cryptographic backends (OpenSSL or NSS, as configured
+by the user), and also wraps other cryptographic code in src/ext.
+
**/