summaryrefslogtreecommitdiff
path: root/src/lib/net/socks5_status.h
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2018-07-10 12:22:01 -0400
committerNick Mathewson <nickm@torproject.org>2018-07-10 12:22:01 -0400
commit4f42c923d61655235ebbae82f64106ecff9458d7 (patch)
tree10246207ad5003f7c6ba40a64af0dbb7801af41f /src/lib/net/socks5_status.h
parent4793d913503f9349ca4b57d77a47bd1bbceecfe5 (diff)
downloadtor-4f42c923d61655235ebbae82f64106ecff9458d7.tar.gz
tor-4f42c923d61655235ebbae82f64106ecff9458d7.zip
File-level summary documentation for src/lib/*/*.[ch]
Diffstat (limited to 'src/lib/net/socks5_status.h')
-rw-r--r--src/lib/net/socks5_status.h10
1 files changed, 10 insertions, 0 deletions
diff --git a/src/lib/net/socks5_status.h b/src/lib/net/socks5_status.h
index 74b9c91023..0f31132545 100644
--- a/src/lib/net/socks5_status.h
+++ b/src/lib/net/socks5_status.h
@@ -3,6 +3,16 @@
* Copyright (c) 2007-2018, The Tor Project, Inc. */
/* See LICENSE for licensing information */
+/**
+ * \file socks5_status.h
+ * \brief Status codes used by the SOCKS5 protocol.
+ **/
+
+/* NOTE: it probably isn't necessary to put this header in lib/net, but
+ * we need it in _some_ lower-level layer for now, since it is used by
+ * tools/tor-resolve.c.
+ */
+
#ifndef TOR_SOCKS5_STATUS_H
#define TOR_SOCKS5_STATUS_H