doxygen: add @file declarations for src/feature/

If a file doesn't use the file command (either \file or @file),
Doxygen won't try to process it.

diff --git a/src/feature/api/tor_api_internal.h b/src/feature/api/tor_api_internal.h
index 60e0f3aa59a16835bbf3e7f2032b5d65f0e5d57d..115d33d58e1a2fda8a08529907b4cb48f1d3f63d 100644 (file)
--- a/src/feature/api/tor_api_internal.h
+++ b/src/feature/api/tor_api_internal.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file tor_api_internal.h
+ * @brief Internal declarations for in-process Tor API.
+ **/
+
 #ifndef TOR_API_INTERNAL_H
 #define TOR_API_INTERNAL_H
 

diff --git a/src/feature/client/addressmap.h b/src/feature/client/addressmap.h
index 9179aef1d0ed5bcb3865c454dc3ac3bfba21072a..eb9742c50ba971ae8b8554ea90622307b4a0e3fa 100644 (file)
--- a/src/feature/client/addressmap.h
+++ b/src/feature/client/addressmap.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file addressmap.h
+ * @brief Header for addressmap.c
+ **/
+
 #ifndef TOR_ADDRESSMAP_H
 #define TOR_ADDRESSMAP_H
 
@@ -62,4 +67,3 @@ STATIC void get_random_virtual_addr(const virtual_addr_conf_t *conf,
 #endif /* defined(ADDRESSMAP_PRIVATE) */
 
 #endif /* !defined(TOR_ADDRESSMAP_H) */
-

diff --git a/src/feature/client/proxymode.c b/src/feature/client/proxymode.c
index 3b5fba5cdaa4f74419fc2582d0241ac00a68eb03..06822053361e739a03f1f548ef375f6013332483 100644 (file)
--- a/src/feature/client/proxymode.c
+++ b/src/feature/client/proxymode.c
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file proxymode.c
+ * @brief Determine whether we are trying to be a proxy.
+ **/
+
 #include "core/or/or.h"
 
 #include "app/config/config.h"

diff --git a/src/feature/control/control_connection_st.h b/src/feature/control/control_connection_st.h
index c9164f03b3675f3cc6b8ae090938d8834de74937..8ecce5ee698e23900232a38af3ca7af6f2770030 100644 (file)
--- a/src/feature/control/control_connection_st.h
+++ b/src/feature/control/control_connection_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file control_connection_st.h
+ * @brief Controller connection structure.
+ **/
+
 #ifndef CONTROL_CONNECTION_ST_H
 #define CONTROL_CONNECTION_ST_H
 

diff --git a/src/feature/control/fmt_serverstatus.c b/src/feature/control/fmt_serverstatus.c
index 33c5ba133619991880254784679442751327c448..92db70758fc73af9ba35e4302866dc158d02ba45 100644 (file)
--- a/src/feature/control/fmt_serverstatus.c
+++ b/src/feature/control/fmt_serverstatus.c
@@ -3,6 +3,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file fmt_serverstatus.c
+ * @brief Format relay info for a controller.
+ **/
+
 #include "core/or/or.h"
 #include "feature/control/fmt_serverstatus.h"
 

diff --git a/src/feature/control/getinfo_geoip.c b/src/feature/control/getinfo_geoip.c
index d188725fa3aa5728ae1941d427c74a33cb33ec0b..4636ede03935458ccdae2757c19f5d4374680f0f 100644 (file)
--- a/src/feature/control/getinfo_geoip.c
+++ b/src/feature/control/getinfo_geoip.c
@@ -1,3 +1,12 @@
+/* Copyright (c) 2001-2004, Roger Dingledine.
+ * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
+ * Copyright (c) 2007-2019, The Tor Project, Inc. */
+/* See LICENSE for licensing information */
+
+/**
+ * @file getinfo_geoip.c
+ * @brief GEOIP-related contoller GETINFO commands.
+ **/
 
 #include "core/or/or.h"
 #include "core/mainloop/connection.h"

diff --git a/src/feature/control/getinfo_geoip.h b/src/feature/control/getinfo_geoip.h
index 94759d0d1832b99b5715768bace81e6352d1dfaf..f6bc86cb5314be8caa5a7d9fe5f445e1bfe0718c 100644 (file)
--- a/src/feature/control/getinfo_geoip.h
+++ b/src/feature/control/getinfo_geoip.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file getinfo_geoip.h
+ * @brief Header for getinfo_geoip.c
+ **/
+
 #ifndef TOR_GETINFO_GEOIP_H
 #define TOR_GETINFO_GEOIP_H
 

diff --git a/src/feature/dirauth/bridgeauth.c b/src/feature/dirauth/bridgeauth.c
index 4aaefc7a6dd697d59ac39184032b73979f5a7cf0..56782011c27e9f13e5a05353e4d6bff02ab08130 100644 (file)
--- a/src/feature/dirauth/bridgeauth.c
+++ b/src/feature/dirauth/bridgeauth.c
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file bridgeauth.c
+ * @brief Bridge authority code
+ **/
+
 #include "core/or/or.h"
 #include "feature/dirauth/bridgeauth.h"
 #include "feature/dirauth/voteflags.h"

diff --git a/src/feature/dirauth/bridgeauth.h b/src/feature/dirauth/bridgeauth.h
index 4905e9c3eea14c660bb1c0e9aac34c443145778d..76676e8db56eb486a5ed24ab774d585c79167e09 100644 (file)
--- a/src/feature/dirauth/bridgeauth.h
+++ b/src/feature/dirauth/bridgeauth.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file bridgeauth.h
+ * @brief Header for bridgeauth.c
+ **/
+
 #ifndef TOR_DIRAUTH_BRIDGEAUTH_H
 #define TOR_DIRAUTH_BRIDGEAUTH_H
 

diff --git a/src/feature/dirauth/dirauth_periodic.c b/src/feature/dirauth/dirauth_periodic.c
index fc26358290fb0e6566a2b02ecbf37eeb201447c4..96194b4677aba39a6f33c2cc889f4728fe3cd629 100644 (file)
--- a/src/feature/dirauth/dirauth_periodic.c
+++ b/src/feature/dirauth/dirauth_periodic.c
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file dirauth_periodic.c
+ * @brief Peridoic events for directory authorities.
+ **/
+
 #include "core/or/or.h"
 
 #include "app/config/or_options_st.h"

diff --git a/src/feature/dirauth/dirauth_periodic.h b/src/feature/dirauth/dirauth_periodic.h
index 866fbd35de036658ed14f527e5149a4d9b409427..de4a799d377599b422c1edbb4f047b119dca15c7 100644 (file)
--- a/src/feature/dirauth/dirauth_periodic.h
+++ b/src/feature/dirauth/dirauth_periodic.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file dirauth_periodic.h
+ * @brief Header for dirauth_periodic.c
+ **/
+
 #ifndef DIRVOTE_PERIODIC_H
 #define DIRVOTE_PERIODIC_H
 

diff --git a/src/feature/dirauth/dirauth_sys.c b/src/feature/dirauth/dirauth_sys.c
index e38d391300848b18a5f89378963c4bc146e28c7a..090e9129f23b9e6cd38106eb353949d75c51cb98 100644 (file)
--- a/src/feature/dirauth/dirauth_sys.c
+++ b/src/feature/dirauth/dirauth_sys.c
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file dirauth_sys.c
+ * @brief Directory authority subsystem declarations
+ **/
+
 #include "core/or/or.h"
 
 #include "feature/dirauth/bwauth.h"

diff --git a/src/feature/dirauth/dirauth_sys.h b/src/feature/dirauth/dirauth_sys.h
index 4e9b6a2ab4d5c888f022527b81201a138c3161a7..2d5a0cb3e7cf73c5445959964f92aec783cca5e5 100644 (file)
--- a/src/feature/dirauth/dirauth_sys.h
+++ b/src/feature/dirauth/dirauth_sys.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file dirauth_sys.h
+ * @brief Header for dirauth_sys.c
+ **/
+
 #ifndef DIRAUTH_SYS_H
 #define DIRAUTH_SYS_H
 

diff --git a/src/feature/dirauth/keypin.h b/src/feature/dirauth/keypin.h
index 1de84f6d4af9b84be064010ac28374926596dfec..d77f6fc5f315d8d1e3627b862d832bde809a5844 100644 (file)
--- a/src/feature/dirauth/keypin.h
+++ b/src/feature/dirauth/keypin.h
@@ -1,6 +1,11 @@
 /* Copyright (c) 2014-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file keypin.h
+ * @brief Header for keypin.c
+ **/
+
 #ifndef TOR_KEYPIN_H
 #define TOR_KEYPIN_H
 

diff --git a/src/feature/dirauth/ns_detached_signatures_st.h b/src/feature/dirauth/ns_detached_signatures_st.h
index 61d20b7525f884114f65129eaf7e67ffe36e4688..7c50cda40a02a81aee3d3bcb86a5261bfeaf2710 100644 (file)
--- a/src/feature/dirauth/ns_detached_signatures_st.h
+++ b/src/feature/dirauth/ns_detached_signatures_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file ns_detached_signatures_st.h
+ * @brief Detached consensus signatures structure.
+ **/
+
 #ifndef NS_DETACHED_SIGNATURES_ST_H
 #define NS_DETACHED_SIGNATURES_ST_H
 
@@ -19,4 +24,3 @@ struct ns_detached_signatures_t {
 };
 
 #endif /* !defined(NS_DETACHED_SIGNATURES_ST_H) */
-

diff --git a/src/feature/dirauth/shared_random_state.h b/src/feature/dirauth/shared_random_state.h
index f6bcddd0885153a912e7b8c92e47f065c0316fd2..74792967a7a4fb220efcdc1049b22b2a30adcc31 100644 (file)
--- a/src/feature/dirauth/shared_random_state.h
+++ b/src/feature/dirauth/shared_random_state.h
@@ -1,6 +1,11 @@
 /* Copyright (c) 2016-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file shared_random_state.h
+ * @brief Header for shared_random_state.c
+ **/
+
 #ifndef TOR_SHARED_RANDOM_STATE_H
 #define TOR_SHARED_RANDOM_STATE_H
 

diff --git a/src/feature/dirauth/vote_microdesc_hash_st.h b/src/feature/dirauth/vote_microdesc_hash_st.h
index 7869f92b4f70ef02633a310d226c49b27f7eb5b7..24c7443b36884966719a3f672a691a275e0c6b39 100644 (file)
--- a/src/feature/dirauth/vote_microdesc_hash_st.h
+++ b/src/feature/dirauth/vote_microdesc_hash_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file vote_microdesc_hash_st.h
+ * @brief Microdescriptor-hash voting strcture.
+ **/
+
 #ifndef VOTE_MICRODESC_HASH_ST_H
 #define VOTE_MICRODESC_HASH_ST_H
 
@@ -19,4 +24,3 @@ struct vote_microdesc_hash_t {
 };
 
 #endif /* !defined(VOTE_MICRODESC_HASH_ST_H) */
-

diff --git a/src/feature/dircache/cached_dir_st.h b/src/feature/dircache/cached_dir_st.h
index a28802f905caf5a3a150a6b225427c7df0f2d655..e086f5b11dc77180d039c440185a7951c66dfce1 100644 (file)
--- a/src/feature/dircache/cached_dir_st.h
+++ b/src/feature/dircache/cached_dir_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file cached_dir_st.h
+ * @brief Cached large directory object structure.
+ **/
+
 #ifndef CACHED_DIR_ST_H
 #define CACHED_DIR_ST_H
 
@@ -22,4 +27,3 @@ struct cached_dir_t {
 };
 
 #endif /* !defined(CACHED_DIR_ST_H) */
-

diff --git a/src/feature/dircache/conscache.c b/src/feature/dircache/conscache.c
index 2ec9981c03e1c12764de92f4d14d884b0432d11e..80da52aa1b82e7d91675a383d56053ec5fb181de 100644 (file)
--- a/src/feature/dircache/conscache.c
+++ b/src/feature/dircache/conscache.c
@@ -1,6 +1,11 @@
 /* Copyright (c) 2017-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file conscache.c
+ * @brief Consensus and diff on-disk cache.
+ **/
+
 #include "core/or/or.h"
 
 #include "app/config/config.h"

diff --git a/src/feature/dircache/conscache.h b/src/feature/dircache/conscache.h
index d848e5761799b49b85e494d9c7ecfd35ae7e71b3..54c081c0680939f46042606044a771fd3965e903 100644 (file)
--- a/src/feature/dircache/conscache.h
+++ b/src/feature/dircache/conscache.h
@@ -1,6 +1,11 @@
 /* Copyright (c) 2017-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file conscache.h
+ * @brief Header for conscache.c
+ **/
+
 #ifndef TOR_CONSCACHE_H
 #define TOR_CONSCACHE_H
 

diff --git a/src/feature/dircache/consdiffmgr.h b/src/feature/dircache/consdiffmgr.h
index b1b3323b6cb38ca97c715f3ab6febf4d6f5858e3..72223536500169b3341f53837f74d26328f24808 100644 (file)
--- a/src/feature/dircache/consdiffmgr.h
+++ b/src/feature/dircache/consdiffmgr.h
@@ -1,6 +1,11 @@
 /* Copyright (c) 2017-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file consdiffmgr.h
+ * @brief Header for consdiffmgr.c
+ **/
+
 #ifndef TOR_CONSDIFFMGR_H
 #define TOR_CONSDIFFMGR_H
 

diff --git a/src/feature/dircache/dircache.c b/src/feature/dircache/dircache.c
index d4d0ad99398cea3d0700915ead0925e149809540..91d5a7e487abba057a26f351cb42b79f70cf0d0c 100644 (file)
--- a/src/feature/dircache/dircache.c
+++ b/src/feature/dircache/dircache.c
@@ -3,6 +3,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file dircache.c
+ * @brief Cache directories and serve them to clients.
+ **/
+
 #define DIRCACHE_PRIVATE
 
 #include "core/or/or.h"

diff --git a/src/feature/dirclient/dir_server_st.h b/src/feature/dirclient/dir_server_st.h
index 8e35532435cdfdbba70e9b586a64636ffa320e95..69c385618582732d5d2ad03c7398e3f9e52cdd31 100644 (file)
--- a/src/feature/dirclient/dir_server_st.h
+++ b/src/feature/dirclient/dir_server_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file dir_server_st.h
+ * @brief Trusted/fallback directory server structure.
+ **/
+
 #ifndef DIR_SERVER_ST_H
 #define DIR_SERVER_ST_H
 

diff --git a/src/feature/dirclient/dirclient.c b/src/feature/dirclient/dirclient.c
index 1ea50fd35025e88029f5fe5dd793862735f16918..a97b425944d0838fb7eae6dd2c43dd5f2dc1591c 100644 (file)
--- a/src/feature/dirclient/dirclient.c
+++ b/src/feature/dirclient/dirclient.c
@@ -3,6 +3,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file dirclient.c
+ * @brief Download directory information
+ **/
+
 #define DIRCLIENT_PRIVATE
 
 #include "core/or/or.h"

diff --git a/src/feature/dirclient/dlstatus.c b/src/feature/dirclient/dlstatus.c
index 0842a2c6767d866fba8a42f289846e43dac1e626..c6fdbebed913ce6813d96de644ff6a29d5d108b4 100644 (file)
--- a/src/feature/dirclient/dlstatus.c
+++ b/src/feature/dirclient/dlstatus.c
@@ -3,6 +3,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file dlstatus.c
+ * @brief Track status and retry schedule of a downloadable object.
+ **/
+
 #define DLSTATUS_PRIVATE
 
 #include "core/or/or.h"

diff --git a/src/feature/dirclient/download_status_st.h b/src/feature/dirclient/download_status_st.h
index 39a5ad286096b11221c0fda59c31361bf5ca58fc..29d0dd5d5f752ddc387c9fa0d79f3003ae6df9b0 100644 (file)
--- a/src/feature/dirclient/download_status_st.h
+++ b/src/feature/dirclient/download_status_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file download_status_st.h
+ * @brief Directory download status/schedule structure.
+ **/
+
 #ifndef DOWNLOAD_STATUS_ST_H
 #define DOWNLOAD_STATUS_ST_H
 
@@ -62,4 +67,3 @@ struct download_status_t {
 };
 
 #endif /* !defined(DOWNLOAD_STATUS_ST_H) */
-

diff --git a/src/feature/dircommon/consdiff.h b/src/feature/dircommon/consdiff.h
index b63fcb2cc6604206f60e0751dc425b11291ccc54..0e8c4b4d8e27848c9e4c50702c66a4eb49eced4c 100644 (file)
--- a/src/feature/dircommon/consdiff.h
+++ b/src/feature/dircommon/consdiff.h
@@ -2,6 +2,11 @@
  * Copyright (c) 2014-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file consdiff.h
+ * @brief Header for consdiff.c
+ **/
+
 #ifndef TOR_CONSDIFF_H
 #define TOR_CONSDIFF_H
 

diff --git a/src/feature/dircommon/dir_connection_st.h b/src/feature/dircommon/dir_connection_st.h
index a858560c2952cb79b9c397c0620b3570411d7b3b..ba978e142a598b52aec8219a7d37f6dfc4a5ee56 100644 (file)
--- a/src/feature/dircommon/dir_connection_st.h
+++ b/src/feature/dircommon/dir_connection_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file dir_connection_st.h
+ * @brief Client/server directory connection structure.
+ **/
+
 #ifndef DIR_CONNECTION_ST_H
 #define DIR_CONNECTION_ST_H
 

diff --git a/src/feature/dircommon/vote_timing_st.h b/src/feature/dircommon/vote_timing_st.h
index 814a325314b83cfaa23c89ca076d709ee5f474d7..352a69b2dd291020e8eba3c35f2f3e4cb97a0f83 100644 (file)
--- a/src/feature/dircommon/vote_timing_st.h
+++ b/src/feature/dircommon/vote_timing_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file vote_timing_st.h
+ * @brief Directory voting schedule structure.
+ **/
+
 #ifndef VOTE_TIMING_ST_H
 #define VOTE_TIMING_ST_H
 
@@ -21,4 +26,3 @@ struct vote_timing_t {
 };
 
 #endif /* !defined(VOTE_TIMING_ST_H) */
-

diff --git a/src/feature/dirparse/authcert_parse.c b/src/feature/dirparse/authcert_parse.c
index d22293e2815b36758695f17ee1e5c45a09a9c3fb..b18e1159f3b898dedc3782a967a1a2d5ff915a60 100644 (file)
--- a/src/feature/dirparse/authcert_parse.c
+++ b/src/feature/dirparse/authcert_parse.c
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file authcert_parse.c
+ * @brief Authority certificate parsing.
+ **/
+
 #include "core/or/or.h"
 #include "feature/dirparse/authcert_parse.h"
 #include "feature/dirparse/parsecommon.h"

diff --git a/src/feature/dirparse/unparseable.c b/src/feature/dirparse/unparseable.c
index 941b5a1f6db597fd61ba084d46fc836a8af39823..3b96df9e300599bb45242043acebba6cbe4512bf 100644 (file)
--- a/src/feature/dirparse/unparseable.c
+++ b/src/feature/dirparse/unparseable.c
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file unparseable.c
+ * @brief Dump unparseable objects to disk.
+ **/
+
 #define UNPARSEABLE_PRIVATE
 
 #include "core/or/or.h"

diff --git a/src/feature/hs/hsdir_index_st.h b/src/feature/hs/hsdir_index_st.h
index 6c86c02f4764e2d16b3f4f7701aacbf2e8f84962..34ff84f91f813a5a14d1a7a5391433b828a824f6 100644 (file)
--- a/src/feature/hs/hsdir_index_st.h
+++ b/src/feature/hs/hsdir_index_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file hsdir_index_st.h
+ * @brief HS directory index structure
+ **/
+
 #ifndef HSDIR_INDEX_ST_H
 #define HSDIR_INDEX_ST_H
 
@@ -21,4 +26,3 @@ struct hsdir_index_t {
 };
 
 #endif /* !defined(HSDIR_INDEX_ST_H) */
-

diff --git a/src/feature/nodelist/authority_cert_st.h b/src/feature/nodelist/authority_cert_st.h
index bf9b690c248fc4edb2feb1f9e92b2c32ce137f92..6787487c7c462acd62f6533912c579229acba58b 100644 (file)
--- a/src/feature/nodelist/authority_cert_st.h
+++ b/src/feature/nodelist/authority_cert_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file authority_cert_st.h
+ * @brief Authority certificate structure.
+ **/
+
 #ifndef AUTHORITY_CERT_ST_H
 #define AUTHORITY_CERT_ST_H
 
@@ -29,4 +34,3 @@ struct authority_cert_t {
 };
 
 #endif /* !defined(AUTHORITY_CERT_ST_H) */
-

diff --git a/src/feature/nodelist/desc_store_st.h b/src/feature/nodelist/desc_store_st.h
index 4d1378cdfa08769370dbc058eae5d3661461b2bf..75300ecf9780e70ef1fbcaed341555c49c2a1b1b 100644 (file)
--- a/src/feature/nodelist/desc_store_st.h
+++ b/src/feature/nodelist/desc_store_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file desc_store_st.h
+ * @brief Routerinfo/extrainfo storage structure.
+ **/
+
 #ifndef DESC_STORE_ST_H
 #define DESC_STORE_ST_H
 

diff --git a/src/feature/nodelist/document_signature_st.h b/src/feature/nodelist/document_signature_st.h
index ac2a80325256a91b5bf010203b451008cbd2cc34..ba4581c1b86c2c5ffddceebf1da3682694df622c 100644 (file)
--- a/src/feature/nodelist/document_signature_st.h
+++ b/src/feature/nodelist/document_signature_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file document_signature_st.h
+ * @brief Authority signature structure
+ **/
+
 #ifndef DOCUMENT_SIGNATURE_ST_H
 #define DOCUMENT_SIGNATURE_ST_H
 
@@ -26,4 +31,3 @@ struct document_signature_t {
 };
 
 #endif /* !defined(DOCUMENT_SIGNATURE_ST_H) */
-

diff --git a/src/feature/nodelist/extrainfo_st.h b/src/feature/nodelist/extrainfo_st.h
index 22c708f018c55d79da0bf87082b5d51b9e7bb928..6d707bea056fa3b2f6c4b24d4c7c1886bfb936ad 100644 (file)
--- a/src/feature/nodelist/extrainfo_st.h
+++ b/src/feature/nodelist/extrainfo_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file extrainfo_st.h
+ * @brief A relay's extra-info structure.
+ **/
+
 #ifndef EXTRAINFO_ST_H
 #define EXTRAINFO_ST_H
 
@@ -27,4 +32,3 @@ struct extrainfo_t {
 };
 
 #endif /* !defined(EXTRAINFO_ST_H) */
-

diff --git a/src/feature/nodelist/microdesc_st.h b/src/feature/nodelist/microdesc_st.h
index e017c46c793f98cbae71d5662ba7c27b7a98675d..58b0630573e2392156923f0817cf5781f6b6f6ec 100644 (file)
--- a/src/feature/nodelist/microdesc_st.h
+++ b/src/feature/nodelist/microdesc_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file microdesc_st.h
+ * @brief Microdescriptor structure
+ **/
+
 #ifndef MICRODESC_ST_H
 #define MICRODESC_ST_H
 

diff --git a/src/feature/nodelist/networkstatus_sr_info_st.h b/src/feature/nodelist/networkstatus_sr_info_st.h
index 420c3d61e4019583863b77ca188131d801cfe3e0..1392fa6853f231b4275213d31942bf237412439f 100644 (file)
--- a/src/feature/nodelist/networkstatus_sr_info_st.h
+++ b/src/feature/nodelist/networkstatus_sr_info_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file networkstatus_sr_info_st.h
+ * @brief Shared-randomness structure.
+ **/
+
 #ifndef NETWORKSTATUS_SR_INFO_ST_H
 #define NETWORKSTATUS_SR_INFO_ST_H
 
@@ -20,4 +25,3 @@ struct networkstatus_sr_info_t {
 };
 
 #endif /* !defined(NETWORKSTATUS_SR_INFO_ST_H) */
-

diff --git a/src/feature/nodelist/networkstatus_st.h b/src/feature/nodelist/networkstatus_st.h
index 6e84c170d6452998247e15b95c623e017bab0c88..a23ef0c19314f8f14fb5e598b99b9d6661063d0e 100644 (file)
--- a/src/feature/nodelist/networkstatus_st.h
+++ b/src/feature/nodelist/networkstatus_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file networkstatus_st.h
+ * @brief Networkstatus consensus/vote structure.
+ **/
+
 #ifndef NETWORKSTATUS_ST_H
 #define NETWORKSTATUS_ST_H
 

diff --git a/src/feature/nodelist/networkstatus_voter_info_st.h b/src/feature/nodelist/networkstatus_voter_info_st.h
index 66af82a8e34c950d9d1c36575e246902f686ea8f..629cb522540bf9d87fc9a987c4388af1430a8113 100644 (file)
--- a/src/feature/nodelist/networkstatus_voter_info_st.h
+++ b/src/feature/nodelist/networkstatus_voter_info_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file networkstatus_voter_info_st.h
+ * @brief Single consensus voter structure.
+ **/
+
 #ifndef NETWORKSTATUS_VOTER_INFO_ST_H
 #define NETWORKSTATUS_VOTER_INFO_ST_H
 

diff --git a/src/feature/nodelist/node_st.h b/src/feature/nodelist/node_st.h
index c63a535a19626ea5ebab627eda26913432dfaed8..6ad10bb85a8f6d9636019ca5f612442421c5be38 100644 (file)
--- a/src/feature/nodelist/node_st.h
+++ b/src/feature/nodelist/node_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file node_st.h
+ * @brief Node information structure.
+ **/
+
 #ifndef NODE_ST_H
 #define NODE_ST_H
 

diff --git a/src/feature/nodelist/nodefamily_st.h b/src/feature/nodelist/nodefamily_st.h
index 20390c93089b8fcac27fde72a3c3638b910804ba..4aa00b025557e6d85633335d51a0bb717bc6222d 100644 (file)
--- a/src/feature/nodelist/nodefamily_st.h
+++ b/src/feature/nodelist/nodefamily_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file nodefamily_st.h
+ * @brief Compact node-family structure
+ **/
+
 #ifndef TOR_NODEFAMILY_ST_H
 #define TOR_NODEFAMILY_ST_H
 

diff --git a/src/feature/nodelist/routerinfo.c b/src/feature/nodelist/routerinfo.c
index 975b5036152a4eb037e8a70b4a1c9ac7d93c3574..4e570fcbb2f029ba1267e3c736aa83514fa1c0cb 100644 (file)
--- a/src/feature/nodelist/routerinfo.c
+++ b/src/feature/nodelist/routerinfo.c
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file routerinfo.c
+ * @brief Manipulate full router descriptors.
+ **/
+
 #include "core/or/or.h"
 
 #include "feature/nodelist/nodelist.h"

diff --git a/src/feature/nodelist/routerinfo_st.h b/src/feature/nodelist/routerinfo_st.h
index 59fd56d0a054effbf7c26152af291fbf6a039987..16387f1005a7f55819518c213765186440c59990 100644 (file)
--- a/src/feature/nodelist/routerinfo_st.h
+++ b/src/feature/nodelist/routerinfo_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file routerinfo_st.h
+ * @brief Router descriptor structure.
+ **/
+
 #ifndef ROUTERINFO_ST_H
 #define ROUTERINFO_ST_H
 

diff --git a/src/feature/nodelist/routerlist_st.h b/src/feature/nodelist/routerlist_st.h
index 10b919a1bf402254b40c1628a4d299ffca43f2ae..d3a3874983b93666df4cf020d2952ddca7a55ba0 100644 (file)
--- a/src/feature/nodelist/routerlist_st.h
+++ b/src/feature/nodelist/routerlist_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file routerlist_st.h
+ * @brief Router descriptor list structure.
+ **/
+
 #ifndef ROUTERLIST_ST_H
 #define ROUTERLIST_ST_H
 
@@ -37,4 +42,3 @@ struct routerlist_t {
 };
 
 #endif /* !defined(ROUTERLIST_ST_H) */
-

diff --git a/src/feature/nodelist/routerstatus_st.h b/src/feature/nodelist/routerstatus_st.h
index 46337c9e5206961cd2c428a67f4f59f875562d10..b60e0e41d01012d884342503cfac39dd5c6773fa 100644 (file)
--- a/src/feature/nodelist/routerstatus_st.h
+++ b/src/feature/nodelist/routerstatus_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file routerstatus_st.h
+ * @brief Routerstatus (consensus entry) structure
+ **/
+
 #ifndef ROUTERSTATUS_ST_H
 #define ROUTERSTATUS_ST_H
 
@@ -79,4 +84,3 @@ struct routerstatus_t {
 };
 
 #endif /* !defined(ROUTERSTATUS_ST_H) */
-

diff --git a/src/feature/nodelist/signed_descriptor_st.h b/src/feature/nodelist/signed_descriptor_st.h
index 64c28f7440865b4127239e21005846f8bb073a01..952fc702f4176d324f11d1c499d28893aff6e02f 100644 (file)
--- a/src/feature/nodelist/signed_descriptor_st.h
+++ b/src/feature/nodelist/signed_descriptor_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file signed_descriptor_st.h
+ * @brief Descriptor/extrainfo signature structure
+ **/
+
 #ifndef SIGNED_DESCRIPTOR_ST_H
 #define SIGNED_DESCRIPTOR_ST_H
 
@@ -58,4 +63,3 @@ struct signed_descriptor_t {
 };
 
 #endif /* !defined(SIGNED_DESCRIPTOR_ST_H) */
-

diff --git a/src/feature/nodelist/torcert.h b/src/feature/nodelist/torcert.h
index 03d5bdca93a32c0f9b895afdd7d49b06c63ad5fb..5a1f9323920bff8f29dfd715b52835cfbee8d587 100644 (file)
--- a/src/feature/nodelist/torcert.h
+++ b/src/feature/nodelist/torcert.h
@@ -1,6 +1,11 @@
 /* Copyright (c) 2014-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file torcert.h
+ * @brief Header for torcert.c
+ **/
+
 #ifndef TORCERT_H_INCLUDED
 #define TORCERT_H_INCLUDED
 

diff --git a/src/feature/nodelist/vote_routerstatus_st.h b/src/feature/nodelist/vote_routerstatus_st.h
index 0d909da2602b11e28c56a90935f62c2d08ff141a..e34b5e5f690ceb3479c25f5e2f5de92cbb260ec8 100644 (file)
--- a/src/feature/nodelist/vote_routerstatus_st.h
+++ b/src/feature/nodelist/vote_routerstatus_st.h
@@ -4,6 +4,10 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file vote_routerstatus_st.h
+ * @brief Routerstatus (vote entry) structure
+ **/
 #ifndef VOTE_ROUTERSTATUS_ST_H
 #define VOTE_ROUTERSTATUS_ST_H
 

diff --git a/src/feature/relay/ext_orport.h b/src/feature/relay/ext_orport.h
index 7313ebd03d2ebf049e8f2c7806d0dd64b7f12e7a..a981ca80c2c2bd3113c870dac0de2e832c22798e 100644 (file)
--- a/src/feature/relay/ext_orport.h
+++ b/src/feature/relay/ext_orport.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file ext_orport.h
+ * @brief Header for ext_orport.c
+ **/
+
 #ifndef EXT_ORPORT_H
 #define EXT_ORPORT_H
 

diff --git a/src/feature/relay/routerkeys.h b/src/feature/relay/routerkeys.h
index cde07b52c37bb9b965d10cd663d302cbecd8d771..d2860718b27bf42653998e8120aa31a8a1fabaf7 100644 (file)
--- a/src/feature/relay/routerkeys.h
+++ b/src/feature/relay/routerkeys.h
@@ -1,6 +1,11 @@
 /* Copyright (c) 2014-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file routerkeys.h
+ * @brief Header for routerkeys.c
+ **/
+
 #ifndef TOR_ROUTERKEYS_H
 #define TOR_ROUTERKEYS_H
 

diff --git a/src/feature/relay/routermode.c b/src/feature/relay/routermode.c
index 3613841b1e332677fe99a1cb65485a7b43e3536d..92bcfaf8fa67d24d01e003e16509118ae7a5dbc6 100644 (file)
--- a/src/feature/relay/routermode.c
+++ b/src/feature/relay/routermode.c
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file routermode.c
+ * @brief Check if we're running as a relay/cache.
+ **/
+
 #include "core/or/or.h"
 
 #include "app/config/config.h"

diff --git a/src/feature/rend/rend_authorized_client_st.h b/src/feature/rend/rend_authorized_client_st.h
index 51a1798fcb2eebdc72f4ece8ee10776798441cf7..0819f2134a0d77104087b6047a1f195470031bbc 100644 (file)
--- a/src/feature/rend/rend_authorized_client_st.h
+++ b/src/feature/rend/rend_authorized_client_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file rend_authorized_client_st.h
+ * @brief Hidden-service authorized client structure.
+ **/
+
 #ifndef REND_AUTHORIZED_CLIENT_ST_H
 #define REND_AUTHORIZED_CLIENT_ST_H
 
@@ -15,4 +20,3 @@ struct rend_authorized_client_t {
 };
 
 #endif /* !defined(REND_AUTHORIZED_CLIENT_ST_H) */
-

diff --git a/src/feature/rend/rend_encoded_v2_service_descriptor_st.h b/src/feature/rend/rend_encoded_v2_service_descriptor_st.h
index bd8a60f0d990145c766a563ec48f558c29ec4c24..5eec600fd1e7c12f4c689846cd738e43ba55dff1 100644 (file)
--- a/src/feature/rend/rend_encoded_v2_service_descriptor_st.h
+++ b/src/feature/rend/rend_encoded_v2_service_descriptor_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file rend_encoded_v2_service_descriptor_st.h
+ * @brief Encoded v2 HS descriptor structure.
+ **/
+
 #ifndef REND_ENCODED_V2_SERVICE_DESCRIPTOR_ST_H
 #define REND_ENCODED_V2_SERVICE_DESCRIPTOR_ST_H
 
@@ -14,4 +19,3 @@ struct rend_encoded_v2_service_descriptor_t {
 };
 
 #endif /* !defined(REND_ENCODED_V2_SERVICE_DESCRIPTOR_ST_H) */
-

diff --git a/src/feature/rend/rend_intro_point_st.h b/src/feature/rend/rend_intro_point_st.h
index 4882b6275289b1379ca98991f4d5a4bb55543e12..9acf155708c853ae005f82e9259b4a4dae0b984c 100644 (file)
--- a/src/feature/rend/rend_intro_point_st.h
+++ b/src/feature/rend/rend_intro_point_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file rend_intro_point_st.h
+ * @brief v2 hidden service introduction point structure.
+ **/
+
 #ifndef REND_INTRO_POINT_ST_H
 #define REND_INTRO_POINT_ST_H
 

diff --git a/src/feature/rend/rend_service_descriptor_st.h b/src/feature/rend/rend_service_descriptor_st.h
index ff7627ce967393ad7839c397fb45ed3c79657443..bdfe87dcae1deeb76aeb67d25f85183cc47a882d 100644 (file)
--- a/src/feature/rend/rend_service_descriptor_st.h
+++ b/src/feature/rend/rend_service_descriptor_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file rend_service_descriptor_st.h
+ * @brief Parsed v2 HS descriptor structure.
+ **/
+
 #ifndef REND_SERVICE_DESCRIPTOR_ST_H
 #define REND_SERVICE_DESCRIPTOR_ST_H
 
@@ -31,4 +36,3 @@ struct rend_service_descriptor_t {
 };
 
 #endif /* !defined(REND_SERVICE_DESCRIPTOR_ST_H) */
-