summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2019-11-05 08:05:42 -0500
committerNick Mathewson <nickm@torproject.org>2019-11-05 08:05:42 -0500
commitaac80a004f91a453733fed0ba62c00d7d1e2b76d (patch)
treecef5f77dd01a088e73b9dd60581726ad7075787b /src
parentdb402028102f2c98bc92a85b7f7e919c0edf76a1 (diff)
downloadtor-aac80a004f91a453733fed0ba62c00d7d1e2b76d.tar.gz
tor-aac80a004f91a453733fed0ba62c00d7d1e2b76d.zip
Doxygen: add several missing links.
Diffstat (limited to 'src')
-rw-r--r--src/feature/dirauth/feature_dirauth.dox5
-rw-r--r--src/feature/hs/feature_hs.dox5
-rw-r--r--src/feature/rend/feature_rend.dox4
-rw-r--r--src/mainpage.dox8
4 files changed, 18 insertions, 4 deletions
diff --git a/src/feature/dirauth/feature_dirauth.dox b/src/feature/dirauth/feature_dirauth.dox
index 93c680e472..9ee2d04589 100644
--- a/src/feature/dirauth/feature_dirauth.dox
+++ b/src/feature/dirauth/feature_dirauth.dox
@@ -3,4 +3,9 @@
@brief feature/dirauth: Directory authority implementation.
This module handles running Tor as a directory authority.
+
+The directory protocol is specified in
+[dir-spec.txt](https://gitweb.torproject.org/torspec.git/tree/dir-spec.txt).
+
+
**/
diff --git a/src/feature/hs/feature_hs.dox b/src/feature/hs/feature_hs.dox
index 35a574d015..32f44d57fb 100644
--- a/src/feature/hs/feature_hs.dox
+++ b/src/feature/hs/feature_hs.dox
@@ -2,4 +2,9 @@
@dir /feature/hs
@brief feature/hs: v3 (current) onion service protocol
+This directory implements the v3 onion service protocol,
+as specified in
+[rend-spec-v3.txt](https://gitweb.torproject.org/torspec.git/tree/rend-spec-v3.txt).
+
+
**/
diff --git a/src/feature/rend/feature_rend.dox b/src/feature/rend/feature_rend.dox
index e92406804d..ed0784521c 100644
--- a/src/feature/rend/feature_rend.dox
+++ b/src/feature/rend/feature_rend.dox
@@ -2,4 +2,8 @@
@dir /feature/rend
@brief feature/rend: version 2 (old) hidden services
+This directory implements the v2 onion service protocol,
+as specified in
+[rend-spec-v2.txt](https://gitweb.torproject.org/torspec.git/tree/rend-spec-v2.txt).
+
**/
diff --git a/src/mainpage.dox b/src/mainpage.dox
index 7c64e0dffb..02ce8675e7 100644
--- a/src/mainpage.dox
+++ b/src/mainpage.dox
@@ -1,9 +1,7 @@
/**
@mainpage Tor source reference
-@section intro Getting to know Tor
-
-Welcome!
+@section intro Welcome to Tor
This documentation describes the general structure of the Tor codebase, how
it fits together, what functionality is available for extending Tor, and
@@ -22,7 +20,9 @@ This document is not an overview of the Tor protocol. For that, see the
design paper and the specifications at https://spec.torproject.org/ .
For more information about Tor's coding standards and some helpful
-development tools, see doc/HACKING in the Tor repository.
+development tools, see
+[doc/HACKING](https://gitweb.torproject.org/tor.git/tree/doc/HACKING) in the
+Tor repository.
@section highlevel The very high level