aboutsummaryrefslogtreecommitdiff
path: root/src/feature/dirparse
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2019-11-04 17:07:38 -0500
committerNick Mathewson <nickm@torproject.org>2019-11-04 17:07:38 -0500
commita33d1dce8affdaef7d84a6cc2c23c3821192cb87 (patch)
tree89dd783a339f0152b912913595661805326b572c /src/feature/dirparse
parente1cdca2e4f58c108539fe4c36205b16caca8d44f (diff)
downloadtor-a33d1dce8affdaef7d84a6cc2c23c3821192cb87.tar.gz
tor-a33d1dce8affdaef7d84a6cc2c23c3821192cb87.zip
directory-level documentation for feature/*
Diffstat (limited to 'src/feature/dirparse')
-rw-r--r--src/feature/dirparse/feature_dirparse.dox8
1 files changed, 7 insertions, 1 deletions
diff --git a/src/feature/dirparse/feature_dirparse.dox b/src/feature/dirparse/feature_dirparse.dox
index 934d8e424b..4f2136b02b 100644
--- a/src/feature/dirparse/feature_dirparse.dox
+++ b/src/feature/dirparse/feature_dirparse.dox
@@ -1,4 +1,10 @@
/**
@dir /feature/dirparse
-@brief feature/dirparse
+@brief feature/dirparse: Parsing Tor directory objects
+
+We define a number of "directory objects" in
+[dir-spec.txt](https://gitweb.torproject.org/torspec.git/tree/dir-spec.txt),
+all of them using a common line-oriented meta-format. This module is used by
+other parts of Tor to parse them.
+
**/