commit 7fc077ed2558c8174237388d00924fd139f786ce parent afc267e8872f0cb780d8c8bd7c0ea4e1d1683a87 Author: Nick Mathewson <nickm@torproject.org> Date: Sun, 3 Nov 2019 15:15:07 -0500 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 Diffstat:
68 files changed, 272 insertions(+), 0 deletions(-)
diff --git a/src/app/app.dox b/src/app/app.dox @@ -0,0 +1,4 @@ +/** +@dir app +@brief app +**/ diff --git a/src/app/config/app_config.dox b/src/app/config/app_config.dox @@ -0,0 +1,4 @@ +/** +@dir app/config +@brief app/config +**/ diff --git a/src/app/main/app_main.dox b/src/app/main/app_main.dox @@ -0,0 +1,4 @@ +/** +@dir app/main +@brief app/main +**/ diff --git a/src/core/core.dox b/src/core/core.dox @@ -0,0 +1,4 @@ +/** +@dir core +@brief core +**/ diff --git a/src/core/crypto/core_crypto.dox b/src/core/crypto/core_crypto.dox @@ -0,0 +1,4 @@ +/** +@dir core/crypto +@brief core/crypto +**/ diff --git a/src/core/mainloop/core_mainloop.dox b/src/core/mainloop/core_mainloop.dox @@ -0,0 +1,4 @@ +/** +@dir core/mainloop +@brief core/mainloop +**/ diff --git a/src/core/or/core_or.dox b/src/core/or/core_or.dox @@ -0,0 +1,4 @@ +/** +@dir core/or +@brief core/or +**/ diff --git a/src/core/proto/core_proto.dox b/src/core/proto/core_proto.dox @@ -0,0 +1,4 @@ +/** +@dir core/proto +@brief core/proto +**/ diff --git a/src/feature/api/feature_api.dox b/src/feature/api/feature_api.dox @@ -0,0 +1,4 @@ +/** +@dir feature/api +@brief feature/api +**/ diff --git a/src/feature/client/feature_client.dox b/src/feature/client/feature_client.dox @@ -0,0 +1,4 @@ +/** +@dir feature/client +@brief feature/client +**/ diff --git a/src/feature/control/feature_control.dox b/src/feature/control/feature_control.dox @@ -0,0 +1,4 @@ +/** +@dir feature/control +@brief feature/control +**/ diff --git a/src/feature/dirauth/feature_dirauth.dox b/src/feature/dirauth/feature_dirauth.dox @@ -0,0 +1,4 @@ +/** +@dir feature/dirauth +@brief feature/dirauth +**/ diff --git a/src/feature/dircache/feature_dircache.dox b/src/feature/dircache/feature_dircache.dox @@ -0,0 +1,4 @@ +/** +@dir feature/dircache +@brief feature/dircache +**/ diff --git a/src/feature/dirclient/feature_dirclient.dox b/src/feature/dirclient/feature_dirclient.dox @@ -0,0 +1,4 @@ +/** +@dir feature/dirclient +@brief feature/dirclient +**/ diff --git a/src/feature/dircommon/feature_dircommon.dox b/src/feature/dircommon/feature_dircommon.dox @@ -0,0 +1,4 @@ +/** +@dir feature/dircommon +@brief feature/dircommon +**/ diff --git a/src/feature/dirparse/feature_dirparse.dox b/src/feature/dirparse/feature_dirparse.dox @@ -0,0 +1,4 @@ +/** +@dir feature/dirparse +@brief feature/dirparse +**/ diff --git a/src/feature/feature.dox b/src/feature/feature.dox @@ -0,0 +1,4 @@ +/** +@dir feature +@brief feature +**/ diff --git a/src/feature/hibernate/feature_hibernate.dox b/src/feature/hibernate/feature_hibernate.dox @@ -0,0 +1,4 @@ +/** +@dir feature/hibernate +@brief feature/hibernate +**/ diff --git a/src/feature/hs/feature_hs.dox b/src/feature/hs/feature_hs.dox @@ -0,0 +1,4 @@ +/** +@dir feature/hs +@brief feature/hs +**/ diff --git a/src/feature/hs_common/feature_hs_common.dox b/src/feature/hs_common/feature_hs_common.dox @@ -0,0 +1,4 @@ +/** +@dir feature/hs_common +@brief feature/hs_common +**/ diff --git a/src/feature/keymgt/feature_keymgt.dox b/src/feature/keymgt/feature_keymgt.dox @@ -0,0 +1,4 @@ +/** +@dir feature/keymgt +@brief feature/keymgt +**/ diff --git a/src/feature/nodelist/feature_nodelist.dox b/src/feature/nodelist/feature_nodelist.dox @@ -0,0 +1,4 @@ +/** +@dir feature/nodelist +@brief feature/nodelist +**/ diff --git a/src/feature/relay/feature_relay.dox b/src/feature/relay/feature_relay.dox @@ -0,0 +1,4 @@ +/** +@dir feature/relay +@brief feature/relay +**/ diff --git a/src/feature/rend/feature_rend.dox b/src/feature/rend/feature_rend.dox @@ -0,0 +1,4 @@ +/** +@dir feature/rend +@brief feature/rend +**/ diff --git a/src/feature/stats/feature_stats.dox b/src/feature/stats/feature_stats.dox @@ -0,0 +1,4 @@ +/** +@dir feature/stats +@brief feature/stats +**/ diff --git a/src/lib/arch/lib_arch.dox b/src/lib/arch/lib_arch.dox @@ -0,0 +1,4 @@ +/** +@dir lib/arch +@brief lib/arch +**/ diff --git a/src/lib/buf/lib_buf.dox b/src/lib/buf/lib_buf.dox @@ -0,0 +1,4 @@ +/** +@dir lib/buf +@brief lib/buf +**/ diff --git a/src/lib/cc/lib_cc.dox b/src/lib/cc/lib_cc.dox @@ -0,0 +1,4 @@ +/** +@dir lib/cc +@brief lib/cc +**/ diff --git a/src/lib/compress/lib_compress.dox b/src/lib/compress/lib_compress.dox @@ -0,0 +1,4 @@ +/** +@dir lib/compress +@brief lib/compress +**/ diff --git a/src/lib/conf/lib_conf.dox b/src/lib/conf/lib_conf.dox @@ -0,0 +1,4 @@ +/** +@dir lib/conf +@brief lib/conf +**/ diff --git a/src/lib/confmgt/lib_confmgt.dox b/src/lib/confmgt/lib_confmgt.dox @@ -0,0 +1,4 @@ +/** +@dir lib/confmgt +@brief lib/confmgt +**/ diff --git a/src/lib/container/lib_container.dox b/src/lib/container/lib_container.dox @@ -0,0 +1,4 @@ +/** +@dir lib/container +@brief lib/container +**/ diff --git a/src/lib/crypt_ops/lib_crypt_ops.dox b/src/lib/crypt_ops/lib_crypt_ops.dox @@ -0,0 +1,4 @@ +/** +@dir lib/crypt_ops +@brief lib/crypt_ops +**/ diff --git a/src/lib/ctime/lib_ctime.dox b/src/lib/ctime/lib_ctime.dox @@ -0,0 +1,4 @@ +/** +@dir lib/ctime +@brief lib/ctime +**/ diff --git a/src/lib/defs/lib_defs.dox b/src/lib/defs/lib_defs.dox @@ -0,0 +1,4 @@ +/** +@dir lib/defs +@brief lib/defs +**/ diff --git a/src/lib/dispatch/lib_dispatch.dox b/src/lib/dispatch/lib_dispatch.dox @@ -0,0 +1,4 @@ +/** +@dir lib/dispatch +@brief lib/dispatch +**/ diff --git a/src/lib/encoding/lib_encoding.dox b/src/lib/encoding/lib_encoding.dox @@ -0,0 +1,4 @@ +/** +@dir lib/encoding +@brief lib/encoding +**/ diff --git a/src/lib/err/lib_err.dox b/src/lib/err/lib_err.dox @@ -0,0 +1,4 @@ +/** +@dir lib/err +@brief lib/err +**/ diff --git a/src/lib/evloop/lib_evloop.dox b/src/lib/evloop/lib_evloop.dox @@ -0,0 +1,4 @@ +/** +@dir lib/evloop +@brief lib/evloop +**/ diff --git a/src/lib/fdio/lib_fdio.dox b/src/lib/fdio/lib_fdio.dox @@ -0,0 +1,4 @@ +/** +@dir lib/fdio +@brief lib/fdio +**/ diff --git a/src/lib/fs/lib_fs.dox b/src/lib/fs/lib_fs.dox @@ -0,0 +1,4 @@ +/** +@dir lib/fs +@brief lib/fs +**/ diff --git a/src/lib/geoip/lib_geoip.dox b/src/lib/geoip/lib_geoip.dox @@ -0,0 +1,4 @@ +/** +@dir lib/geoip +@brief lib/geoip +**/ diff --git a/src/lib/intmath/lib_intmath.dox b/src/lib/intmath/lib_intmath.dox @@ -0,0 +1,4 @@ +/** +@dir lib/intmath +@brief lib/intmath +**/ diff --git a/src/lib/lib.dox b/src/lib/lib.dox @@ -0,0 +1,4 @@ +/** +@dir lib +@brief lib +**/ diff --git a/src/lib/lock/lib_lock.dox b/src/lib/lock/lib_lock.dox @@ -0,0 +1,4 @@ +/** +@dir lib/lock +@brief lib/lock +**/ diff --git a/src/lib/log/lib_log.dox b/src/lib/log/lib_log.dox @@ -0,0 +1,4 @@ +/** +@dir lib/log +@brief lib/log +**/ diff --git a/src/lib/malloc/lib_malloc.dox b/src/lib/malloc/lib_malloc.dox @@ -0,0 +1,4 @@ +/** +@dir lib/malloc +@brief lib/malloc +**/ diff --git a/src/lib/math/lib_math.dox b/src/lib/math/lib_math.dox @@ -0,0 +1,4 @@ +/** +@dir lib/math +@brief lib/math +**/ diff --git a/src/lib/memarea/lib_memarea.dox b/src/lib/memarea/lib_memarea.dox @@ -0,0 +1,4 @@ +/** +@dir lib/memarea +@brief lib/memarea +**/ diff --git a/src/lib/meminfo/lib_meminfo.dox b/src/lib/meminfo/lib_meminfo.dox @@ -0,0 +1,4 @@ +/** +@dir lib/meminfo +@brief lib/meminfo +**/ diff --git a/src/lib/net/lib_net.dox b/src/lib/net/lib_net.dox @@ -0,0 +1,4 @@ +/** +@dir lib/net +@brief lib/net +**/ diff --git a/src/lib/osinfo/lib_osinfo.dox b/src/lib/osinfo/lib_osinfo.dox @@ -0,0 +1,4 @@ +/** +@dir lib/osinfo +@brief lib/osinfo +**/ diff --git a/src/lib/process/lib_process.dox b/src/lib/process/lib_process.dox @@ -0,0 +1,4 @@ +/** +@dir lib/process +@brief lib/process +**/ diff --git a/src/lib/pubsub/lib_pubsub.dox b/src/lib/pubsub/lib_pubsub.dox @@ -0,0 +1,4 @@ +/** +@dir lib/pubsub +@brief lib/pubsub +**/ diff --git a/src/lib/sandbox/lib_sandbox.dox b/src/lib/sandbox/lib_sandbox.dox @@ -0,0 +1,4 @@ +/** +@dir lib/sandbox +@brief lib/sandbox +**/ diff --git a/src/lib/smartlist_core/lib_smartlist_core.dox b/src/lib/smartlist_core/lib_smartlist_core.dox @@ -0,0 +1,4 @@ +/** +@dir lib/smartlist_core +@brief lib/smartlist_core +**/ diff --git a/src/lib/stats/lib_stats.dox b/src/lib/stats/lib_stats.dox @@ -0,0 +1,4 @@ +/** +@dir lib/stats +@brief lib/stats +**/ diff --git a/src/lib/string/lib_string.dox b/src/lib/string/lib_string.dox @@ -0,0 +1,4 @@ +/** +@dir lib/string +@brief lib/string +**/ diff --git a/src/lib/subsys/lib_subsys.dox b/src/lib/subsys/lib_subsys.dox @@ -0,0 +1,4 @@ +/** +@dir lib/subsys +@brief lib/subsys +**/ diff --git a/src/lib/term/lib_term.dox b/src/lib/term/lib_term.dox @@ -0,0 +1,4 @@ +/** +@dir lib/term +@brief lib/term +**/ diff --git a/src/lib/testsupport/lib_testsupport.dox b/src/lib/testsupport/lib_testsupport.dox @@ -0,0 +1,4 @@ +/** +@dir lib/testsupport +@brief lib/testsupport +**/ diff --git a/src/lib/thread/lib_thread.dox b/src/lib/thread/lib_thread.dox @@ -0,0 +1,4 @@ +/** +@dir lib/thread +@brief lib/thread +**/ diff --git a/src/lib/time/lib_time.dox b/src/lib/time/lib_time.dox @@ -0,0 +1,4 @@ +/** +@dir lib/time +@brief lib/time +**/ diff --git a/src/lib/tls/lib_tls.dox b/src/lib/tls/lib_tls.dox @@ -0,0 +1,4 @@ +/** +@dir lib/tls +@brief lib/tls +**/ diff --git a/src/lib/trace/lib_trace.dox b/src/lib/trace/lib_trace.dox @@ -0,0 +1,4 @@ +/** +@dir lib/trace +@brief lib/trace +**/ diff --git a/src/lib/version/lib_version.dox b/src/lib/version/lib_version.dox @@ -0,0 +1,4 @@ +/** +@dir lib/version +@brief lib/version +**/ diff --git a/src/lib/wallclock/lib_wallclock.dox b/src/lib/wallclock/lib_wallclock.dox @@ -0,0 +1,4 @@ +/** +@dir lib/wallclock +@brief lib/wallclock +**/ diff --git a/src/tools/tools.dox b/src/tools/tools.dox @@ -0,0 +1,4 @@ +/** +@dir tools +@brief tools +**/