summaryrefslogtreecommitdiff
path: root/src/lib
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2019-11-03 15:15:07 -0500
committerNick Mathewson <nickm@torproject.org>2019-11-04 07:40:14 -0500
commit7fc077ed2558c8174237388d00924fd139f786ce (patch)
tree164c006fc6396ce6fc09b33ea74130a2de59d60e /src/lib
parentafc267e8872f0cb780d8c8bd7c0ea4e1d1683a87 (diff)
downloadtor-7fc077ed2558c8174237388d00924fd139f786ce.tar.gz
tor-7fc077ed2558c8174237388d00924fd139f786ce.zip
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 (limited to 'src/lib')
-rw-r--r--src/lib/arch/lib_arch.dox4
-rw-r--r--src/lib/buf/lib_buf.dox4
-rw-r--r--src/lib/cc/lib_cc.dox4
-rw-r--r--src/lib/compress/lib_compress.dox4
-rw-r--r--src/lib/conf/lib_conf.dox4
-rw-r--r--src/lib/confmgt/lib_confmgt.dox4
-rw-r--r--src/lib/container/lib_container.dox4
-rw-r--r--src/lib/crypt_ops/lib_crypt_ops.dox4
-rw-r--r--src/lib/ctime/lib_ctime.dox4
-rw-r--r--src/lib/defs/lib_defs.dox4
-rw-r--r--src/lib/dispatch/lib_dispatch.dox4
-rw-r--r--src/lib/encoding/lib_encoding.dox4
-rw-r--r--src/lib/err/lib_err.dox4
-rw-r--r--src/lib/evloop/lib_evloop.dox4
-rw-r--r--src/lib/fdio/lib_fdio.dox4
-rw-r--r--src/lib/fs/lib_fs.dox4
-rw-r--r--src/lib/geoip/lib_geoip.dox4
-rw-r--r--src/lib/intmath/lib_intmath.dox4
-rw-r--r--src/lib/lib.dox4
-rw-r--r--src/lib/lock/lib_lock.dox4
-rw-r--r--src/lib/log/lib_log.dox4
-rw-r--r--src/lib/malloc/lib_malloc.dox4
-rw-r--r--src/lib/math/lib_math.dox4
-rw-r--r--src/lib/memarea/lib_memarea.dox4
-rw-r--r--src/lib/meminfo/lib_meminfo.dox4
-rw-r--r--src/lib/net/lib_net.dox4
-rw-r--r--src/lib/osinfo/lib_osinfo.dox4
-rw-r--r--src/lib/process/lib_process.dox4
-rw-r--r--src/lib/pubsub/lib_pubsub.dox4
-rw-r--r--src/lib/sandbox/lib_sandbox.dox4
-rw-r--r--src/lib/smartlist_core/lib_smartlist_core.dox4
-rw-r--r--src/lib/stats/lib_stats.dox4
-rw-r--r--src/lib/string/lib_string.dox4
-rw-r--r--src/lib/subsys/lib_subsys.dox4
-rw-r--r--src/lib/term/lib_term.dox4
-rw-r--r--src/lib/testsupport/lib_testsupport.dox4
-rw-r--r--src/lib/thread/lib_thread.dox4
-rw-r--r--src/lib/time/lib_time.dox4
-rw-r--r--src/lib/tls/lib_tls.dox4
-rw-r--r--src/lib/trace/lib_trace.dox4
-rw-r--r--src/lib/version/lib_version.dox4
-rw-r--r--src/lib/wallclock/lib_wallclock.dox4
42 files changed, 168 insertions, 0 deletions
diff --git a/src/lib/arch/lib_arch.dox b/src/lib/arch/lib_arch.dox
new file mode 100644
index 0000000000..60b5fafeb4
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..f21c4b1b72
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..804260cb29
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..ac60794565
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..40a1d9f90f
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..964fe1d074
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..6ee719f47e
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..1ea0b67d59
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..476c95991c
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..5adb527fc7
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..f194eff481
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..4a5fad9271
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..8994fa5fd8
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..86b60e3cd5
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..b868d28aab
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..ad775ba553
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..7ad99e8f55
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..ce71e455d1
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..28d4c52c66
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..44693e7a69
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..915d652407
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..4923f14463
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..c2e121dc8c
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..dbd98de5ec
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..c8def7e2f9
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..03783c12aa
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..7733755f20
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..efb1adc091
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..9a3fc6dfac
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..eb42d97589
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..507d0fe92f
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..897c41418f
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..3e038ea072
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..f9cd5eeb81
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..2bc5125839
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..63ccc47d34
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..68937ef793
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..50abf072f7
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..40b7b2c27e
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..a1ae256506
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..213e1a1ae8
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..7bb2b075d1
--- /dev/null
+++ b/src/lib/wallclock/lib_wallclock.dox
@@ -0,0 +1,4 @@
+/**
+@dir lib/wallclock
+@brief lib/wallclock
+**/