Add stub directory-level documentation for most source directories

This includes app, core, feature, lib, and tools, but excludes
ext, test, and trunnel.

This was generated by the following shell script:

cd src
for dname in $(find lib core feature app tools -type d |grep -v \\.deps$); do
    keyword="$(echo "$dname" |sed -e "s/\//_/" )"
    target="${dname}/${keyword}.dox"
    echo "$target"
    cat <<EOF >"$target"
/**
@dir ${dname}
@brief ${dname}
**/
EOF

    git add "$target"
done
This commit is contained in:
Nick Mathewson
2019-11-03 15:15:07 -05:00
parent afc267e887
commit 7fc077ed25
68 changed files with 272 additions and 0 deletions
+4
View File
@@ -0,0 +1,4 @@
/**
@dir feature/api
@brief feature/api
**/
+4
View File
@@ -0,0 +1,4 @@
/**
@dir feature/client
@brief feature/client
**/
+4
View File
@@ -0,0 +1,4 @@
/**
@dir feature/control
@brief feature/control
**/
+4
View File
@@ -0,0 +1,4 @@
/**
@dir feature/dirauth
@brief feature/dirauth
**/
@@ -0,0 +1,4 @@
/**
@dir feature/dircache
@brief feature/dircache
**/
@@ -0,0 +1,4 @@
/**
@dir feature/dirclient
@brief feature/dirclient
**/
@@ -0,0 +1,4 @@
/**
@dir feature/dircommon
@brief feature/dircommon
**/
@@ -0,0 +1,4 @@
/**
@dir feature/dirparse
@brief feature/dirparse
**/
+4
View File
@@ -0,0 +1,4 @@
/**
@dir feature
@brief feature
**/
@@ -0,0 +1,4 @@
/**
@dir feature/hibernate
@brief feature/hibernate
**/
+4
View File
@@ -0,0 +1,4 @@
/**
@dir feature/hs
@brief feature/hs
**/
@@ -0,0 +1,4 @@
/**
@dir feature/hs_common
@brief feature/hs_common
**/
+4
View File
@@ -0,0 +1,4 @@
/**
@dir feature/keymgt
@brief feature/keymgt
**/
@@ -0,0 +1,4 @@
/**
@dir feature/nodelist
@brief feature/nodelist
**/
+4
View File
@@ -0,0 +1,4 @@
/**
@dir feature/relay
@brief feature/relay
**/
+4
View File
@@ -0,0 +1,4 @@
/**
@dir feature/rend
@brief feature/rend
**/
+4
View File
@@ -0,0 +1,4 @@
/**
@dir feature/stats
@brief feature/stats
**/