mirror of
https://gitlab.torproject.org/tpo/core/tor.git
synced 2024-11-11 05:33:47 +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:
parent
afc267e887
commit
7fc077ed25
4
src/app/app.dox
Normal file
4
src/app/app.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir app
|
||||
@brief app
|
||||
**/
|
4
src/app/config/app_config.dox
Normal file
4
src/app/config/app_config.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir app/config
|
||||
@brief app/config
|
||||
**/
|
4
src/app/main/app_main.dox
Normal file
4
src/app/main/app_main.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir app/main
|
||||
@brief app/main
|
||||
**/
|
4
src/core/core.dox
Normal file
4
src/core/core.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir core
|
||||
@brief core
|
||||
**/
|
4
src/core/crypto/core_crypto.dox
Normal file
4
src/core/crypto/core_crypto.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir core/crypto
|
||||
@brief core/crypto
|
||||
**/
|
4
src/core/mainloop/core_mainloop.dox
Normal file
4
src/core/mainloop/core_mainloop.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir core/mainloop
|
||||
@brief core/mainloop
|
||||
**/
|
4
src/core/or/core_or.dox
Normal file
4
src/core/or/core_or.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir core/or
|
||||
@brief core/or
|
||||
**/
|
4
src/core/proto/core_proto.dox
Normal file
4
src/core/proto/core_proto.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir core/proto
|
||||
@brief core/proto
|
||||
**/
|
4
src/feature/api/feature_api.dox
Normal file
4
src/feature/api/feature_api.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir feature/api
|
||||
@brief feature/api
|
||||
**/
|
4
src/feature/client/feature_client.dox
Normal file
4
src/feature/client/feature_client.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir feature/client
|
||||
@brief feature/client
|
||||
**/
|
4
src/feature/control/feature_control.dox
Normal file
4
src/feature/control/feature_control.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir feature/control
|
||||
@brief feature/control
|
||||
**/
|
4
src/feature/dirauth/feature_dirauth.dox
Normal file
4
src/feature/dirauth/feature_dirauth.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir feature/dirauth
|
||||
@brief feature/dirauth
|
||||
**/
|
4
src/feature/dircache/feature_dircache.dox
Normal file
4
src/feature/dircache/feature_dircache.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir feature/dircache
|
||||
@brief feature/dircache
|
||||
**/
|
4
src/feature/dirclient/feature_dirclient.dox
Normal file
4
src/feature/dirclient/feature_dirclient.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir feature/dirclient
|
||||
@brief feature/dirclient
|
||||
**/
|
4
src/feature/dircommon/feature_dircommon.dox
Normal file
4
src/feature/dircommon/feature_dircommon.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir feature/dircommon
|
||||
@brief feature/dircommon
|
||||
**/
|
4
src/feature/dirparse/feature_dirparse.dox
Normal file
4
src/feature/dirparse/feature_dirparse.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir feature/dirparse
|
||||
@brief feature/dirparse
|
||||
**/
|
4
src/feature/feature.dox
Normal file
4
src/feature/feature.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir feature
|
||||
@brief feature
|
||||
**/
|
4
src/feature/hibernate/feature_hibernate.dox
Normal file
4
src/feature/hibernate/feature_hibernate.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir feature/hibernate
|
||||
@brief feature/hibernate
|
||||
**/
|
4
src/feature/hs/feature_hs.dox
Normal file
4
src/feature/hs/feature_hs.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir feature/hs
|
||||
@brief feature/hs
|
||||
**/
|
4
src/feature/hs_common/feature_hs_common.dox
Normal file
4
src/feature/hs_common/feature_hs_common.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir feature/hs_common
|
||||
@brief feature/hs_common
|
||||
**/
|
4
src/feature/keymgt/feature_keymgt.dox
Normal file
4
src/feature/keymgt/feature_keymgt.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir feature/keymgt
|
||||
@brief feature/keymgt
|
||||
**/
|
4
src/feature/nodelist/feature_nodelist.dox
Normal file
4
src/feature/nodelist/feature_nodelist.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir feature/nodelist
|
||||
@brief feature/nodelist
|
||||
**/
|
4
src/feature/relay/feature_relay.dox
Normal file
4
src/feature/relay/feature_relay.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir feature/relay
|
||||
@brief feature/relay
|
||||
**/
|
4
src/feature/rend/feature_rend.dox
Normal file
4
src/feature/rend/feature_rend.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir feature/rend
|
||||
@brief feature/rend
|
||||
**/
|
4
src/feature/stats/feature_stats.dox
Normal file
4
src/feature/stats/feature_stats.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir feature/stats
|
||||
@brief feature/stats
|
||||
**/
|
4
src/lib/arch/lib_arch.dox
Normal file
4
src/lib/arch/lib_arch.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/arch
|
||||
@brief lib/arch
|
||||
**/
|
4
src/lib/buf/lib_buf.dox
Normal file
4
src/lib/buf/lib_buf.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/buf
|
||||
@brief lib/buf
|
||||
**/
|
4
src/lib/cc/lib_cc.dox
Normal file
4
src/lib/cc/lib_cc.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/cc
|
||||
@brief lib/cc
|
||||
**/
|
4
src/lib/compress/lib_compress.dox
Normal file
4
src/lib/compress/lib_compress.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/compress
|
||||
@brief lib/compress
|
||||
**/
|
4
src/lib/conf/lib_conf.dox
Normal file
4
src/lib/conf/lib_conf.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/conf
|
||||
@brief lib/conf
|
||||
**/
|
4
src/lib/confmgt/lib_confmgt.dox
Normal file
4
src/lib/confmgt/lib_confmgt.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/confmgt
|
||||
@brief lib/confmgt
|
||||
**/
|
4
src/lib/container/lib_container.dox
Normal file
4
src/lib/container/lib_container.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/container
|
||||
@brief lib/container
|
||||
**/
|
4
src/lib/crypt_ops/lib_crypt_ops.dox
Normal file
4
src/lib/crypt_ops/lib_crypt_ops.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/crypt_ops
|
||||
@brief lib/crypt_ops
|
||||
**/
|
4
src/lib/ctime/lib_ctime.dox
Normal file
4
src/lib/ctime/lib_ctime.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/ctime
|
||||
@brief lib/ctime
|
||||
**/
|
4
src/lib/defs/lib_defs.dox
Normal file
4
src/lib/defs/lib_defs.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/defs
|
||||
@brief lib/defs
|
||||
**/
|
4
src/lib/dispatch/lib_dispatch.dox
Normal file
4
src/lib/dispatch/lib_dispatch.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/dispatch
|
||||
@brief lib/dispatch
|
||||
**/
|
4
src/lib/encoding/lib_encoding.dox
Normal file
4
src/lib/encoding/lib_encoding.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/encoding
|
||||
@brief lib/encoding
|
||||
**/
|
4
src/lib/err/lib_err.dox
Normal file
4
src/lib/err/lib_err.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/err
|
||||
@brief lib/err
|
||||
**/
|
4
src/lib/evloop/lib_evloop.dox
Normal file
4
src/lib/evloop/lib_evloop.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/evloop
|
||||
@brief lib/evloop
|
||||
**/
|
4
src/lib/fdio/lib_fdio.dox
Normal file
4
src/lib/fdio/lib_fdio.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/fdio
|
||||
@brief lib/fdio
|
||||
**/
|
4
src/lib/fs/lib_fs.dox
Normal file
4
src/lib/fs/lib_fs.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/fs
|
||||
@brief lib/fs
|
||||
**/
|
4
src/lib/geoip/lib_geoip.dox
Normal file
4
src/lib/geoip/lib_geoip.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/geoip
|
||||
@brief lib/geoip
|
||||
**/
|
4
src/lib/intmath/lib_intmath.dox
Normal file
4
src/lib/intmath/lib_intmath.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/intmath
|
||||
@brief lib/intmath
|
||||
**/
|
4
src/lib/lib.dox
Normal file
4
src/lib/lib.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib
|
||||
@brief lib
|
||||
**/
|
4
src/lib/lock/lib_lock.dox
Normal file
4
src/lib/lock/lib_lock.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/lock
|
||||
@brief lib/lock
|
||||
**/
|
4
src/lib/log/lib_log.dox
Normal file
4
src/lib/log/lib_log.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/log
|
||||
@brief lib/log
|
||||
**/
|
4
src/lib/malloc/lib_malloc.dox
Normal file
4
src/lib/malloc/lib_malloc.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/malloc
|
||||
@brief lib/malloc
|
||||
**/
|
4
src/lib/math/lib_math.dox
Normal file
4
src/lib/math/lib_math.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/math
|
||||
@brief lib/math
|
||||
**/
|
4
src/lib/memarea/lib_memarea.dox
Normal file
4
src/lib/memarea/lib_memarea.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/memarea
|
||||
@brief lib/memarea
|
||||
**/
|
4
src/lib/meminfo/lib_meminfo.dox
Normal file
4
src/lib/meminfo/lib_meminfo.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/meminfo
|
||||
@brief lib/meminfo
|
||||
**/
|
4
src/lib/net/lib_net.dox
Normal file
4
src/lib/net/lib_net.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/net
|
||||
@brief lib/net
|
||||
**/
|
4
src/lib/osinfo/lib_osinfo.dox
Normal file
4
src/lib/osinfo/lib_osinfo.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/osinfo
|
||||
@brief lib/osinfo
|
||||
**/
|
4
src/lib/process/lib_process.dox
Normal file
4
src/lib/process/lib_process.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/process
|
||||
@brief lib/process
|
||||
**/
|
4
src/lib/pubsub/lib_pubsub.dox
Normal file
4
src/lib/pubsub/lib_pubsub.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/pubsub
|
||||
@brief lib/pubsub
|
||||
**/
|
4
src/lib/sandbox/lib_sandbox.dox
Normal file
4
src/lib/sandbox/lib_sandbox.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/sandbox
|
||||
@brief lib/sandbox
|
||||
**/
|
4
src/lib/smartlist_core/lib_smartlist_core.dox
Normal file
4
src/lib/smartlist_core/lib_smartlist_core.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/smartlist_core
|
||||
@brief lib/smartlist_core
|
||||
**/
|
4
src/lib/stats/lib_stats.dox
Normal file
4
src/lib/stats/lib_stats.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/stats
|
||||
@brief lib/stats
|
||||
**/
|
4
src/lib/string/lib_string.dox
Normal file
4
src/lib/string/lib_string.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/string
|
||||
@brief lib/string
|
||||
**/
|
4
src/lib/subsys/lib_subsys.dox
Normal file
4
src/lib/subsys/lib_subsys.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/subsys
|
||||
@brief lib/subsys
|
||||
**/
|
4
src/lib/term/lib_term.dox
Normal file
4
src/lib/term/lib_term.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/term
|
||||
@brief lib/term
|
||||
**/
|
4
src/lib/testsupport/lib_testsupport.dox
Normal file
4
src/lib/testsupport/lib_testsupport.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/testsupport
|
||||
@brief lib/testsupport
|
||||
**/
|
4
src/lib/thread/lib_thread.dox
Normal file
4
src/lib/thread/lib_thread.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/thread
|
||||
@brief lib/thread
|
||||
**/
|
4
src/lib/time/lib_time.dox
Normal file
4
src/lib/time/lib_time.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/time
|
||||
@brief lib/time
|
||||
**/
|
4
src/lib/tls/lib_tls.dox
Normal file
4
src/lib/tls/lib_tls.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/tls
|
||||
@brief lib/tls
|
||||
**/
|
4
src/lib/trace/lib_trace.dox
Normal file
4
src/lib/trace/lib_trace.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/trace
|
||||
@brief lib/trace
|
||||
**/
|
4
src/lib/version/lib_version.dox
Normal file
4
src/lib/version/lib_version.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/version
|
||||
@brief lib/version
|
||||
**/
|
4
src/lib/wallclock/lib_wallclock.dox
Normal file
4
src/lib/wallclock/lib_wallclock.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir lib/wallclock
|
||||
@brief lib/wallclock
|
||||
**/
|
4
src/tools/tools.dox
Normal file
4
src/tools/tools.dox
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
@dir tools
|
||||
@brief tools
|
||||
**/
|
Loading…
Reference in New Issue
Block a user