doxygen: add @file declarations for src/core/or

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

diff --git a/src/core/or/addr_policy_st.h b/src/core/or/addr_policy_st.h
index 11442d29b492d8a84535eb96032bcf95924ba4ac..41c4ac47eb417d6eb622bb00b616eadf1b50d79d 100644 (file)
--- a/src/core/or/addr_policy_st.h
+++ b/src/core/or/addr_policy_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file addr_policy_st.h
+ * @brief Address policy structures.
+ **/
+
 #ifndef TOR_ADDR_POLICY_ST_H
 #define TOR_ADDR_POLICY_ST_H
 

diff --git a/src/core/or/cell_queue_st.h b/src/core/or/cell_queue_st.h
index 7ba339b965da6665b880379afd70def169a150e1..763bc5bc1e311553d9371203eebb73b31677c0ca 100644 (file)
--- a/src/core/or/cell_queue_st.h
+++ b/src/core/or/cell_queue_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file cell_queue_st.h
+ * @brief Cell queue structures
+ **/
+
 #ifndef PACKED_CELL_ST_H
 #define PACKED_CELL_ST_H
 

diff --git a/src/core/or/cell_st.h b/src/core/or/cell_st.h
index c4eec4f4b57b0a9612ece6fe70e5f25288caf0a8..5c1667d321445e2ff3ade2e1c4354859b7023214 100644 (file)
--- a/src/core/or/cell_st.h
+++ b/src/core/or/cell_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file cell_st.h
+ * @brief Fixed-size cell structure.
+ **/
+
 #ifndef CELL_ST_H
 #define CELL_ST_H
 
@@ -17,4 +22,3 @@ struct cell_t {
 };
 
 #endif /* !defined(CELL_ST_H) */
-

diff --git a/src/core/or/channelpadding.c b/src/core/or/channelpadding.c
index 4a0f0e00da406c856e60286a5efe0901173d0c49..2b8314db89c935bf836694c7c716336a198fe137 100644 (file)
--- a/src/core/or/channelpadding.c
+++ b/src/core/or/channelpadding.c
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file channelpadding.c
+ * @brief Link-level padding code.
+ **/
+
 /* TOR_CHANNEL_INTERNAL_ define needed for an O(1) implementation of
  * channelpadding_channel_to_channelinfo() */
 #define TOR_CHANNEL_INTERNAL_

diff --git a/src/core/or/circuit_st.h b/src/core/or/circuit_st.h
index eae3c908d5870f2f070d743a2857217fba008c70..0c281f725766cd4ff3568a3da3d77ef2c3f74d03 100644 (file)
--- a/src/core/or/circuit_st.h
+++ b/src/core/or/circuit_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file circuit_st.h
+ * @brief Base circuit structure.
+ **/
+
 #ifndef CIRCUIT_ST_H
 #define CIRCUIT_ST_H
 

diff --git a/src/core/or/connection_st.h b/src/core/or/connection_st.h
index 1c42a56d6b615d2fe0bf55559127de8ae4e656c6..08558d79ff5d91055ed08210c97b04ae81dec4a6 100644 (file)
--- a/src/core/or/connection_st.h
+++ b/src/core/or/connection_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file connection_st.h
+ * @brief Base connection structure.
+ **/
+
 #ifndef CONNECTION_ST_H
 #define CONNECTION_ST_H
 

diff --git a/src/core/or/cpath_build_state_st.h b/src/core/or/cpath_build_state_st.h
index 4572a104302b13e4dc381a968e59fe6e5e37a2f7..240badde40000f389953aabb624bf17967e1fe35 100644 (file)
--- a/src/core/or/cpath_build_state_st.h
+++ b/src/core/or/cpath_build_state_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file cpath_build_state_st.h
+ * @brief Circuit-build-stse structure
+ **/
+
 #ifndef CIRCUIT_BUILD_STATE_ST_ST_H
 #define CIRCUIT_BUILD_STATE_ST_ST_H
 
@@ -35,4 +40,3 @@ struct cpath_build_state_t {
 };
 
 #endif /* !defined(CIRCUIT_BUILD_STATE_ST_ST_H) */
-

diff --git a/src/core/or/crypt_path_reference_st.h b/src/core/or/crypt_path_reference_st.h
index 1827022b4e8e273dc5722c2991f23c7d50327493..fb20a3fc5a5fe14b8656ae695624fa92c91b6cfc 100644 (file)
--- a/src/core/or/crypt_path_reference_st.h
+++ b/src/core/or/crypt_path_reference_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file crypt_path_reference_st.h
+ * @brief reference-counting structure for crypt_path_t
+ **/
+
 #ifndef CRYPT_PATH_REFERENCE_ST_H
 #define CRYPT_PATH_REFERENCE_ST_H
 
@@ -20,4 +25,3 @@ struct crypt_path_reference_t {
 };
 
 #endif /* !defined(CRYPT_PATH_REFERENCE_ST_H) */
-

diff --git a/src/core/or/crypt_path_st.h b/src/core/or/crypt_path_st.h
index 249ac6aaa3c2fcca3c74dcd7a63edff03cba71ce..945961d5d15d1313fdc4fa0bc522d891c4007051 100644 (file)
--- a/src/core/or/crypt_path_st.h
+++ b/src/core/or/crypt_path_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file crypt_path_st.h
+ * @brief Path structures for origin circuits.
+ **/
+
 #ifndef CRYPT_PATH_ST_H
 #define CRYPT_PATH_ST_H
 

diff --git a/src/core/or/destroy_cell_queue_st.h b/src/core/or/destroy_cell_queue_st.h
index e917afc7009952c2b34cc401c83c8fd79c775329..fc817c1b429ea4944007d6b83670f533ee6b6423 100644 (file)
--- a/src/core/or/destroy_cell_queue_st.h
+++ b/src/core/or/destroy_cell_queue_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file destroy_cell_queue_st.h
+ * @brief Destroy-cell queue structures
+ **/
+
 #ifndef DESTROY_CELL_QUEUE_ST_H
 #define DESTROY_CELL_QUEUE_ST_H
 
@@ -24,4 +29,3 @@ struct destroy_cell_queue_t {
 };
 
 #endif /* !defined(DESTROY_CELL_QUEUE_ST_H) */
-

diff --git a/src/core/or/edge_connection_st.h b/src/core/or/edge_connection_st.h
index 8922a3a9cfa134aa96b8a2981cd3a88de8c6ee4e..d043d1ffb4319d28e0a5b899d3ecb3a477bf3a23 100644 (file)
--- a/src/core/or/edge_connection_st.h
+++ b/src/core/or/edge_connection_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file edge_connection_st.h
+ * @brief Edge-connection structure.
+ **/
+
 #ifndef EDGE_CONNECTION_ST_H
 #define EDGE_CONNECTION_ST_H
 
@@ -74,4 +79,3 @@ struct edge_connection_t {
 };
 
 #endif /* !defined(EDGE_CONNECTION_ST_H) */
-

diff --git a/src/core/or/entry_connection_st.h b/src/core/or/entry_connection_st.h
index e65c545d17e43b478cb3f7e0e297a6341e25e540..b866e78493bea6253241cd8ed18a9e539abceaf3 100644 (file)
--- a/src/core/or/entry_connection_st.h
+++ b/src/core/or/entry_connection_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file entry_connection_st.h
+ * @brief Entry connection structure.
+ **/
+
 #ifndef ENTRY_CONNECTION_ST_H
 #define ENTRY_CONNECTION_ST_H
 
@@ -97,4 +102,3 @@ struct entry_connection_t {
 #define ENTRY_TO_EDGE_CONN(c) (&(((c))->edge_))
 
 #endif /* !defined(ENTRY_CONNECTION_ST_H) */
-

diff --git a/src/core/or/entry_port_cfg_st.h b/src/core/or/entry_port_cfg_st.h
index b84838d44fa96e2b5044652b9496ee64da4c6cc7..f52f47d1c944c29dfad7c31fa85ce3466d9076b8 100644 (file)
--- a/src/core/or/entry_port_cfg_st.h
+++ b/src/core/or/entry_port_cfg_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file entry_port_cfg_st.h
+ * @brief Configuration structure for client ports.
+ **/
+
 #ifndef ENTRY_PORT_CFG_ST_H
 #define ENTRY_PORT_CFG_ST_H
 
@@ -51,4 +56,3 @@ struct entry_port_cfg_t {
 };
 
 #endif /* !defined(ENTRY_PORT_CFG_ST_H) */
-

diff --git a/src/core/or/extend_info_st.h b/src/core/or/extend_info_st.h
index 7704ff16b58dded483c2d7609299a4d16a0bd53c..babf15c59a24779928d5c8662b40c1bcdb4dfe2e 100644 (file)
--- a/src/core/or/extend_info_st.h
+++ b/src/core/or/extend_info_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file extend_info_st.h
+ * @brief Extend-info structure.
+ **/
+
 #ifndef EXTEND_INFO_ST_H
 #define EXTEND_INFO_ST_H
 

diff --git a/src/core/or/half_edge_st.h b/src/core/or/half_edge_st.h
index 1fe47ad3f1c85bcd403ab81d2c9f10c1c77a1d50..cb2044654febc551d95b5d1395e08bf674a5cc4e 100644 (file)
--- a/src/core/or/half_edge_st.h
+++ b/src/core/or/half_edge_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file half_edge_st.h
+ * @brief Half-open connection structure.
+ **/
+
 #ifndef HALF_EDGE_ST_H
 #define HALF_EDGE_ST_H
 
@@ -31,4 +36,3 @@ typedef struct half_edge_t {
 } half_edge_t;
 
 #endif /* !defined(HALF_EDGE_ST_H) */
-

diff --git a/src/core/or/listener_connection_st.h b/src/core/or/listener_connection_st.h
index 1250d9c9b420d3b6c9de1e160c4366a1a02ea1e1..fafc8444f949b1c32efe577f832a8bc6f0508ddb 100644 (file)
--- a/src/core/or/listener_connection_st.h
+++ b/src/core/or/listener_connection_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file listener_connection_st.h
+ * @brief Listener connection structure.
+ **/
+
 #ifndef LISTENER_CONNECTION_ST_H
 #define LISTENER_CONNECTION_ST_H
 
@@ -22,4 +27,3 @@ struct listener_connection_t {
 };
 
 #endif /* !defined(LISTENER_CONNECTION_ST_H) */
-

diff --git a/src/core/or/or_connection_st.h b/src/core/or/or_connection_st.h
index 051fcd00d311c72b9ea24a75433f3090c51dad15..c364117a353518ea1ac7b2015960a1d88ecede46 100644 (file)
--- a/src/core/or/or_connection_st.h
+++ b/src/core/or/or_connection_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file or_connection_st.h
+ * @brief OR connection structure.
+ **/
+
 #ifndef OR_CONNECTION_ST_H
 #define OR_CONNECTION_ST_H
 

diff --git a/src/core/or/or_handshake_certs_st.h b/src/core/or/or_handshake_certs_st.h
index 9deb6d6d59b72fce1367aafb5900404cbae04ef0..209fee551d1187c99c6f8d7c20524c696e2d9b9d 100644 (file)
--- a/src/core/or/or_handshake_certs_st.h
+++ b/src/core/or/or_handshake_certs_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file or_handshake_certs_st.h
+ * @brief OR handshake certs structure
+ **/
+
 #ifndef OR_HANDSHAKE_CERTS_ST
 #define OR_HANDSHAKE_CERTS_ST
 

diff --git a/src/core/or/or_handshake_state_st.h b/src/core/or/or_handshake_state_st.h
index 472ce8a3027ae40eaf39b5e2a07c6b8be44c01fc..43f88e7565c022128af7c982357e440ff3978b81 100644 (file)
--- a/src/core/or/or_handshake_state_st.h
+++ b/src/core/or/or_handshake_state_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file or_handshake_state_st.h
+ * @brief OR handshake state structure
+ **/
+
 #ifndef OR_HANDSHAKE_STATE_ST
 #define OR_HANDSHAKE_STATE_ST
 
@@ -75,4 +80,3 @@ struct or_handshake_state_t {
 };
 
 #endif /* !defined(OR_HANDSHAKE_STATE_ST) */
-

diff --git a/src/core/or/origin_circuit_st.h b/src/core/or/origin_circuit_st.h
index 01bbc84ae216e1e53d126622a086ce1a0d1172da..cdb3f95a99225972361cfc148bddc49474dda861 100644 (file)
--- a/src/core/or/origin_circuit_st.h
+++ b/src/core/or/origin_circuit_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file origin_circuit_st.h
+ * @brief Origin circuit structure.
+ **/
+
 #ifndef ORIGIN_CIRCUIT_ST_H
 #define ORIGIN_CIRCUIT_ST_H
 

diff --git a/src/core/or/port_cfg_st.h b/src/core/or/port_cfg_st.h
index e9e82bb1dedc839afbfc31dfc78fdcebebf84a97..f27c81d95113b7284e846dbaf63c69542ee8147f 100644 (file)
--- a/src/core/or/port_cfg_st.h
+++ b/src/core/or/port_cfg_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file port_cfg_st.h
+ * @brief Listener port configuration structure.
+ **/
+
 #ifndef PORT_CFG_ST_H
 #define PORT_CFG_ST_H
 
@@ -32,4 +37,3 @@ struct port_cfg_t {
 };
 
 #endif /* !defined(PORT_CFG_ST_H) */
-

diff --git a/src/core/or/relay_crypto_st.h b/src/core/or/relay_crypto_st.h
index 83bbd329a6a3a392ec9975047440597117f696f5..1b1eb16df15cbd206053488a771f619eaee277ea 100644 (file)
--- a/src/core/or/relay_crypto_st.h
+++ b/src/core/or/relay_crypto_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file relay_crypto_st.h
+ * @brief Relay-cell encryption state structure.
+ **/
+
 #ifndef RELAY_CRYPTO_ST_H
 #define RELAY_CRYPTO_ST_H
 

diff --git a/src/core/or/scheduler_kist.c b/src/core/or/scheduler_kist.c
index 35b613cb8aab41359b23e3e7df62a2b7e4d512ed..f4bac7b8779f334118ecc4d7a5a572de5c31c203 100644 (file)
--- a/src/core/or/scheduler_kist.c
+++ b/src/core/or/scheduler_kist.c
@@ -1,6 +1,11 @@
 /* Copyright (c) 2017-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file scheduler_kist.c
+ * @brief Implements the KIST cell scheduler.
+ **/
+
 #define SCHEDULER_KIST_PRIVATE
 
 #include "core/or/or.h"

diff --git a/src/core/or/scheduler_vanilla.c b/src/core/or/scheduler_vanilla.c
index 33536ae04b17bbf5f30390f4b35c82713aa55974..bd84a4e4ef5fbeaab51bcaf48b28645a0e58f254 100644 (file)
--- a/src/core/or/scheduler_vanilla.c
+++ b/src/core/or/scheduler_vanilla.c
@@ -1,6 +1,11 @@
 /* Copyright (c) 2017-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file scheduler_vanilla.c
+ * @brief "Vanilla" (pre-KIST) cell scheduler code.
+ **/
+
 #include "core/or/or.h"
 #include "app/config/config.h"
 #define TOR_CHANNEL_INTERNAL_
@@ -172,4 +177,3 @@ get_vanilla_scheduler(void)
 {
   return &vanilla_scheduler;
 }
-

diff --git a/src/core/or/server_port_cfg_st.h b/src/core/or/server_port_cfg_st.h
index 0738735c61823ff4d408f93f5a99edb8a0807aa6..c160576714f671e7b04275078d51740471b86c21 100644 (file)
--- a/src/core/or/server_port_cfg_st.h
+++ b/src/core/or/server_port_cfg_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file server_port_cfg_st.h
+ * @brief Cnfiguration structure for server ports.
+ **/
+
 #ifndef SERVER_PORT_CFG_ST_H
 #define SERVER_PORT_CFG_ST_H
 
@@ -17,4 +22,3 @@ struct server_port_cfg_t {
 };
 
 #endif /* !defined(SERVER_PORT_CFG_ST_H) */
-

diff --git a/src/core/or/socks_request_st.h b/src/core/or/socks_request_st.h
index 9fb941ff7e5c48d1c3ad9afddbae3b4fbe8f13cd..2931543ee2e61fc429093e3f9033d393729355b6 100644 (file)
--- a/src/core/or/socks_request_st.h
+++ b/src/core/or/socks_request_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file socks_request_st.h
+ * @brief Client request structure.
+ **/
+
 #ifndef SOCKS_REQUEST_ST_H
 #define SOCKS_REQUEST_ST_H
 

diff --git a/src/core/or/status.h b/src/core/or/status.h
index 3467501ebb8475567ca2d9e3eb91f1d0e7efda6c..3568f39d6d90e7cb7fa58ae2de1d13efb65628f9 100644 (file)
--- a/src/core/or/status.h
+++ b/src/core/or/status.h
@@ -1,6 +1,11 @@
 /* Copyright (c) 2010-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file status.h
+ * @brief Header for status.c
+ **/
+
 #ifndef TOR_STATUS_H
 #define TOR_STATUS_H
 
@@ -15,4 +20,3 @@ STATIC char *bytes_to_usage(uint64_t bytes);
 #endif
 
 #endif /* !defined(TOR_STATUS_H) */
-

diff --git a/src/core/or/tor_version_st.h b/src/core/or/tor_version_st.h
index c5bdcaf07b79d21f04b6763068f8eff78be6df5d..c3ef00b9606169e8921055f8443a1ed889f58208 100644 (file)
--- a/src/core/or/tor_version_st.h
+++ b/src/core/or/tor_version_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file tor_version_st.h
+ * @brief Parsed Tor version structure.
+ **/
+
 #ifndef TOR_VERSION_ST_H
 #define TOR_VERSION_ST_H
 
@@ -29,4 +34,3 @@ struct tor_version_t {
 };
 
 #endif /* !defined(TOR_VERSION_ST_H) */
-

diff --git a/src/core/or/var_cell_st.h b/src/core/or/var_cell_st.h
index 607c0d6c83119e5ca9db80203b47e1a719dcb998..5c847202a9650b7a8fc674d90b90337bec176872 100644 (file)
--- a/src/core/or/var_cell_st.h
+++ b/src/core/or/var_cell_st.h
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file var_cell_st.h
+ * @brief Variable-length cell structure.
+ **/
+
 #ifndef VAR_CELL_ST_H
 #define VAR_CELL_ST_H
 
@@ -20,4 +25,3 @@ struct var_cell_t {
 };
 
 #endif /* !defined(VAR_CELL_ST_H) */
-