mirror of
https://gitlab.torproject.org/tpo/core/tor.git
synced 2024-12-06 19:41:15 +01:00
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:
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir app
|
||||
@brief app
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir app/config
|
||||
@brief app/config
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir app/main
|
||||
@brief app/main
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir core
|
||||
@brief core
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir core/crypto
|
||||
@brief core/crypto
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir core/mainloop
|
||||
@brief core/mainloop
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir core/or
|
||||
@brief core/or
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir core/proto
|
||||
@brief core/proto
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir feature/api
|
||||
@brief feature/api
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir feature/client
|
||||
@brief feature/client
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir feature/control
|
||||
@brief feature/control
|
||||
**/
|
||||
@@ -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
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir feature
|
||||
@brief feature
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir feature/hibernate
|
||||
@brief feature/hibernate
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir feature/hs
|
||||
@brief feature/hs
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir feature/hs_common
|
||||
@brief feature/hs_common
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir feature/keymgt
|
||||
@brief feature/keymgt
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir feature/nodelist
|
||||
@brief feature/nodelist
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir feature/relay
|
||||
@brief feature/relay
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir feature/rend
|
||||
@brief feature/rend
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir feature/stats
|
||||
@brief feature/stats
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/arch
|
||||
@brief lib/arch
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/buf
|
||||
@brief lib/buf
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/cc
|
||||
@brief lib/cc
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/compress
|
||||
@brief lib/compress
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/conf
|
||||
@brief lib/conf
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/confmgt
|
||||
@brief lib/confmgt
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/container
|
||||
@brief lib/container
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/crypt_ops
|
||||
@brief lib/crypt_ops
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/ctime
|
||||
@brief lib/ctime
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/defs
|
||||
@brief lib/defs
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/dispatch
|
||||
@brief lib/dispatch
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/encoding
|
||||
@brief lib/encoding
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/err
|
||||
@brief lib/err
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/evloop
|
||||
@brief lib/evloop
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/fdio
|
||||
@brief lib/fdio
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/fs
|
||||
@brief lib/fs
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/geoip
|
||||
@brief lib/geoip
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/intmath
|
||||
@brief lib/intmath
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib
|
||||
@brief lib
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/lock
|
||||
@brief lib/lock
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/log
|
||||
@brief lib/log
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/malloc
|
||||
@brief lib/malloc
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/math
|
||||
@brief lib/math
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/memarea
|
||||
@brief lib/memarea
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/meminfo
|
||||
@brief lib/meminfo
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/net
|
||||
@brief lib/net
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/osinfo
|
||||
@brief lib/osinfo
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/process
|
||||
@brief lib/process
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/pubsub
|
||||
@brief lib/pubsub
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/sandbox
|
||||
@brief lib/sandbox
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/smartlist_core
|
||||
@brief lib/smartlist_core
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/stats
|
||||
@brief lib/stats
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/string
|
||||
@brief lib/string
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/subsys
|
||||
@brief lib/subsys
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/term
|
||||
@brief lib/term
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/testsupport
|
||||
@brief lib/testsupport
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/thread
|
||||
@brief lib/thread
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/time
|
||||
@brief lib/time
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/tls
|
||||
@brief lib/tls
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/trace
|
||||
@brief lib/trace
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/version
|
||||
@brief lib/version
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/wallclock
|
||||
@brief lib/wallclock
|
||||
**/
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir tools
|
||||
@brief tools
|
||||
**/
|
||||
Reference in New Issue
Block a user