aboutsummaryrefslogtreecommitdiff
path: root/src/feature
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/feature
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/feature')
-rw-r--r--src/feature/api/feature_api.dox4
-rw-r--r--src/feature/client/feature_client.dox4
-rw-r--r--src/feature/control/feature_control.dox4
-rw-r--r--src/feature/dirauth/feature_dirauth.dox4
-rw-r--r--src/feature/dircache/feature_dircache.dox4
-rw-r--r--src/feature/dirclient/feature_dirclient.dox4
-rw-r--r--src/feature/dircommon/feature_dircommon.dox4
-rw-r--r--src/feature/dirparse/feature_dirparse.dox4
-rw-r--r--src/feature/feature.dox4
-rw-r--r--src/feature/hibernate/feature_hibernate.dox4
-rw-r--r--src/feature/hs/feature_hs.dox4
-rw-r--r--src/feature/hs_common/feature_hs_common.dox4
-rw-r--r--src/feature/keymgt/feature_keymgt.dox4
-rw-r--r--src/feature/nodelist/feature_nodelist.dox4
-rw-r--r--src/feature/relay/feature_relay.dox4
-rw-r--r--src/feature/rend/feature_rend.dox4
-rw-r--r--src/feature/stats/feature_stats.dox4
17 files changed, 68 insertions, 0 deletions
diff --git a/src/feature/api/feature_api.dox b/src/feature/api/feature_api.dox
new file mode 100644
index 0000000000..cb723b0601
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..1a4881c50a
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..1f6e83c1dd
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..fa4bee5b31
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..5f1c5cc70f
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..984a17cf51
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..2eff21065c
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..a6b34c1f5f
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..880a262a0d
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..e24620a43c
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..08801d002d
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..8fd4f1b07c
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..8f72c70bbd
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..faeb9970b3
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..9aa7af48e6
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..fcba0d460f
--- /dev/null
+++ 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
new file mode 100644
index 0000000000..fc4ffd19df
--- /dev/null
+++ b/src/feature/stats/feature_stats.dox
@@ -0,0 +1,4 @@
+/**
+@dir feature/stats
+@brief feature/stats
+**/