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
src/app/app.dox Normal file
View File

@ -0,0 +1,4 @@
/**
@dir app
@brief app
**/

View File

@ -0,0 +1,4 @@
/**
@dir app/config
@brief app/config
**/

View File

@ -0,0 +1,4 @@
/**
@dir app/main
@brief app/main
**/

4
src/core/core.dox Normal file
View File

@ -0,0 +1,4 @@
/**
@dir core
@brief core
**/

View File

@ -0,0 +1,4 @@
/**
@dir core/crypto
@brief core/crypto
**/

View File

@ -0,0 +1,4 @@
/**
@dir core/mainloop
@brief core/mainloop
**/

4
src/core/or/core_or.dox Normal file
View File

@ -0,0 +1,4 @@
/**
@dir core/or
@brief core/or
**/

View File

@ -0,0 +1,4 @@
/**
@dir core/proto
@brief core/proto
**/

View File

@ -0,0 +1,4 @@
/**
@dir feature/api
@brief feature/api
**/

View File

@ -0,0 +1,4 @@
/**
@dir feature/client
@brief feature/client
**/

View File

@ -0,0 +1,4 @@
/**
@dir feature/control
@brief feature/control
**/

View File

@ -0,0 +1,4 @@
/**
@dir feature/dirauth
@brief feature/dirauth
**/

View File

@ -0,0 +1,4 @@
/**
@dir feature/dircache
@brief feature/dircache
**/

View File

@ -0,0 +1,4 @@
/**
@dir feature/dirclient
@brief feature/dirclient
**/

View File

@ -0,0 +1,4 @@
/**
@dir feature/dircommon
@brief feature/dircommon
**/

View File

@ -0,0 +1,4 @@
/**
@dir feature/dirparse
@brief feature/dirparse
**/

4
src/feature/feature.dox Normal file
View File

@ -0,0 +1,4 @@
/**
@dir feature
@brief feature
**/

View File

@ -0,0 +1,4 @@
/**
@dir feature/hibernate
@brief feature/hibernate
**/

View File

@ -0,0 +1,4 @@
/**
@dir feature/hs
@brief feature/hs
**/

View File

@ -0,0 +1,4 @@
/**
@dir feature/hs_common
@brief feature/hs_common
**/

View File

@ -0,0 +1,4 @@
/**
@dir feature/keymgt
@brief feature/keymgt
**/

View File

@ -0,0 +1,4 @@
/**
@dir feature/nodelist
@brief feature/nodelist
**/

View File

@ -0,0 +1,4 @@
/**
@dir feature/relay
@brief feature/relay
**/

View File

@ -0,0 +1,4 @@
/**
@dir feature/rend
@brief feature/rend
**/

View File

@ -0,0 +1,4 @@
/**
@dir feature/stats
@brief feature/stats
**/

View File

@ -0,0 +1,4 @@
/**
@dir lib/arch
@brief lib/arch
**/

4
src/lib/buf/lib_buf.dox Normal file
View File

@ -0,0 +1,4 @@
/**
@dir lib/buf
@brief lib/buf
**/

4
src/lib/cc/lib_cc.dox Normal file
View File

@ -0,0 +1,4 @@
/**
@dir lib/cc
@brief lib/cc
**/

View File

@ -0,0 +1,4 @@
/**
@dir lib/compress
@brief lib/compress
**/

View File

@ -0,0 +1,4 @@
/**
@dir lib/conf
@brief lib/conf
**/

View File

@ -0,0 +1,4 @@
/**
@dir lib/confmgt
@brief lib/confmgt
**/

View File

@ -0,0 +1,4 @@
/**
@dir lib/container
@brief lib/container
**/

View File

@ -0,0 +1,4 @@
/**
@dir lib/crypt_ops
@brief lib/crypt_ops
**/

View File

@ -0,0 +1,4 @@
/**
@dir lib/ctime
@brief lib/ctime
**/

View File

@ -0,0 +1,4 @@
/**
@dir lib/defs
@brief lib/defs
**/

View File

@ -0,0 +1,4 @@
/**
@dir lib/dispatch
@brief lib/dispatch
**/

View File

@ -0,0 +1,4 @@
/**
@dir lib/encoding
@brief lib/encoding
**/

4
src/lib/err/lib_err.dox Normal file
View File

@ -0,0 +1,4 @@
/**
@dir lib/err
@brief lib/err
**/

View File

@ -0,0 +1,4 @@
/**
@dir lib/evloop
@brief lib/evloop
**/

View File

@ -0,0 +1,4 @@
/**
@dir lib/fdio
@brief lib/fdio
**/

4
src/lib/fs/lib_fs.dox Normal file
View File

@ -0,0 +1,4 @@
/**
@dir lib/fs
@brief lib/fs
**/

View File

@ -0,0 +1,4 @@
/**
@dir lib/geoip
@brief lib/geoip
**/

View File

@ -0,0 +1,4 @@
/**
@dir lib/intmath
@brief lib/intmath
**/

4
src/lib/lib.dox Normal file
View File

@ -0,0 +1,4 @@
/**
@dir lib
@brief lib
**/

View File

@ -0,0 +1,4 @@
/**
@dir lib/lock
@brief lib/lock
**/

4
src/lib/log/lib_log.dox Normal file
View File

@ -0,0 +1,4 @@
/**
@dir lib/log
@brief lib/log
**/

View File

@ -0,0 +1,4 @@
/**
@dir lib/malloc
@brief lib/malloc
**/

View File

@ -0,0 +1,4 @@
/**
@dir lib/math
@brief lib/math
**/

View File

@ -0,0 +1,4 @@
/**
@dir lib/memarea
@brief lib/memarea
**/

View File

@ -0,0 +1,4 @@
/**
@dir lib/meminfo
@brief lib/meminfo
**/

4
src/lib/net/lib_net.dox Normal file
View File

@ -0,0 +1,4 @@
/**
@dir lib/net
@brief lib/net
**/

View File

@ -0,0 +1,4 @@
/**
@dir lib/osinfo
@brief lib/osinfo
**/

View File

@ -0,0 +1,4 @@
/**
@dir lib/process
@brief lib/process
**/

View File

@ -0,0 +1,4 @@
/**
@dir lib/pubsub
@brief lib/pubsub
**/

View File

@ -0,0 +1,4 @@
/**
@dir lib/sandbox
@brief lib/sandbox
**/

View File

@ -0,0 +1,4 @@
/**
@dir lib/smartlist_core
@brief lib/smartlist_core
**/

View File

@ -0,0 +1,4 @@
/**
@dir lib/stats
@brief lib/stats
**/

View File

@ -0,0 +1,4 @@
/**
@dir lib/string
@brief lib/string
**/

View File

@ -0,0 +1,4 @@
/**
@dir lib/subsys
@brief lib/subsys
**/

View File

@ -0,0 +1,4 @@
/**
@dir lib/term
@brief lib/term
**/

View File

@ -0,0 +1,4 @@
/**
@dir lib/testsupport
@brief lib/testsupport
**/

View File

@ -0,0 +1,4 @@
/**
@dir lib/thread
@brief lib/thread
**/

View File

@ -0,0 +1,4 @@
/**
@dir lib/time
@brief lib/time
**/

4
src/lib/tls/lib_tls.dox Normal file
View File

@ -0,0 +1,4 @@
/**
@dir lib/tls
@brief lib/tls
**/

View File

@ -0,0 +1,4 @@
/**
@dir lib/trace
@brief lib/trace
**/

View File

@ -0,0 +1,4 @@
/**
@dir lib/version
@brief lib/version
**/

View File

@ -0,0 +1,4 @@
/**
@dir lib/wallclock
@brief lib/wallclock
**/

4
src/tools/tools.dox Normal file
View File

@ -0,0 +1,4 @@
/**
@dir tools
@brief tools
**/