[tor-commits] [tor/master] Doxygen: add several missing links.

nickm at torproject.org nickm at torproject.org
Tue Nov 5 13:05:57 UTC 2019


commit aac80a004f91a453733fed0ba62c00d7d1e2b76d
Author: Nick Mathewson <nickm at torproject.org>
Date:   Tue Nov 5 08:05:42 2019 -0500

    Doxygen: add several missing links.
---
 src/feature/dirauth/feature_dirauth.dox | 5 +++++
 src/feature/hs/feature_hs.dox           | 5 +++++
 src/feature/rend/feature_rend.dox       | 4 ++++
 src/mainpage.dox                        | 8 ++++----
 4 files changed, 18 insertions(+), 4 deletions(-)

diff --git a/src/feature/dirauth/feature_dirauth.dox b/src/feature/dirauth/feature_dirauth.dox
index 93c680e47..9ee2d0458 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 35a574d01..32f44d57f 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 e92406804..ed0784521 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 7c64e0dff..02ce8675e 100644
--- a/src/mainpage.dox
+++ b/src/mainpage.dox
@@ -1,9 +1,7 @@
 /**
 @mainpage Tor source reference
 
- at section intro Getting to know Tor
-
-Welcome!
+ at 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
 





More information about the tor-commits mailing list