aboutsummaryrefslogtreecommitdiff
path: root/src/lib/compress
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/compress
parent83a4946e7b9d2bb75ab8dfa8073c5dd7b3f77bc9 (diff)
downloadtor-cb1a3674ebb3826d9e1e56146210bd79cb4a42f0.tar.gz
tor-cb1a3674ebb3826d9e1e56146210bd79cb4a42f0.zip
File-level documentation for some of src/lib.
Diffstat (limited to 'src/lib/compress')
-rw-r--r--src/lib/compress/compress.c5
-rw-r--r--src/lib/compress/compress_buf.c6
2 files changed, 10 insertions, 1 deletions
diff --git a/src/lib/compress/compress.c b/src/lib/compress/compress.c
index 2cb5dbaec2..e87e788f14 100644
--- a/src/lib/compress/compress.c
+++ b/src/lib/compress/compress.c
@@ -5,7 +5,10 @@
/**
* \file compress.c
- * \brief Common compression API.
+ * \brief Common compression API implementation.
+ *
+ * This file provides a unified interface to all the compression libraries Tor
+ * knows how to use.
**/
#include "orconfig.h"
diff --git a/src/lib/compress/compress_buf.c b/src/lib/compress/compress_buf.c
index 4b88772382..63ee9e0102 100644
--- a/src/lib/compress/compress_buf.c
+++ b/src/lib/compress/compress_buf.c
@@ -3,6 +3,12 @@
* Copyright (c) 2007-2018, The Tor Project, Inc. */
/* See LICENSE for licensing information */
+/**
+ * \file compress_buf.c
+ *
+ * \brief Working with compressed data in buffers.
+ **/
+
#define BUFFERS_PRIVATE
#include "lib/cc/compat_compiler.h"
#include "lib/container/buffers.h"