directory-level documentation for feature/*

2024-12-06 19:41:15 +01:00 · 2019-11-04 17:07:38 -05:00
parent e1cdca2e4f
commit a33d1dce8a
16 changed files with 73 additions and 16 deletions
@@ -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.
+
 **/