summaryrefslogtreecommitdiff
path: root/src/feature/control/feature_control.dox
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2019-11-05 08:05:49 -0500
committerNick Mathewson <nickm@torproject.org>2019-11-05 08:05:49 -0500
commit8933789fef0e2014852df6ae55b5435b9d3256b2 (patch)
tree03cba4960d76656fd248e60d4d749152bdc62340 /src/feature/control/feature_control.dox
parent60d5ff303d65bb7caf5c064675c661faac4cecf1 (diff)
parentaac80a004f91a453733fed0ba62c00d7d1e2b76d (diff)
downloadtor-8933789fef0e2014852df6ae55b5435b9d3256b2.tar.gz
tor-8933789fef0e2014852df6ae55b5435b9d3256b2.zip
Merge branch 'doxygen_libs'
Diffstat (limited to 'src/feature/control/feature_control.dox')
-rw-r--r--src/feature/control/feature_control.dox10
1 files changed, 8 insertions, 2 deletions
diff --git a/src/feature/control/feature_control.dox b/src/feature/control/feature_control.dox
index 1f6e83c1dd..a0bf9413a1 100644
--- a/src/feature/control/feature_control.dox
+++ b/src/feature/control/feature_control.dox
@@ -1,4 +1,10 @@
/**
-@dir feature/control
-@brief feature/control
+@dir /feature/control
+@brief feature/control: Controller API.
+
+The Controller API is a text-based protocol that another program (or another
+thread, if you're running Tor in-process) can use to configure and control
+Tor while it is running. The current protocol is documented in
+[control-spec.txt](https://gitweb.torproject.org/torspec.git/tree/control-spec.txt).
+
**/