aboutsummaryrefslogtreecommitdiff
path: root/src/lib/compress
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/compress
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/compress')
-rw-r--r--src/lib/compress/lib_compress.dox6
1 files changed, 5 insertions, 1 deletions
diff --git a/src/lib/compress/lib_compress.dox b/src/lib/compress/lib_compress.dox
index b1b0902359..599126901a 100644
--- a/src/lib/compress/lib_compress.dox
+++ b/src/lib/compress/lib_compress.dox
@@ -1,4 +1,8 @@
/**
@dir /lib/compress
-@brief lib/compress
+@brief lib/compress: Wraps several compression libraries
+
+Currently supported are zlib (mandatory), zstd (optional), and lzma
+(optional).
+
**/