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.
This commit is contained in:
Nick Mathewson 2019-10-26 12:05:28 -04:00
parent 30c6ab5150
commit 68f8086041
56 changed files with 283 additions and 17 deletions

View File

@ -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

View File

@ -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) */

View File

@ -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"

View File

@ -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

View File

@ -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"

View File

@ -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"

View File

@ -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

View File

@ -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"

View File

@ -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

View File

@ -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"

View File

@ -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

View File

@ -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"

View File

@ -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

View File

@ -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

View File

@ -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) */

View File

@ -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

View File

@ -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) */

View File

@ -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) */

View File

@ -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"

View File

@ -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

View File

@ -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

View File

@ -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"

View File

@ -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

View File

@ -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"

View File

@ -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"

View File

@ -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) */

View File

@ -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

View File

@ -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

View File

@ -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) */

View File

@ -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"

View File

@ -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"

View File

@ -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) */

View File

@ -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) */

View File

@ -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

View File

@ -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) */

View File

@ -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) */

View File

@ -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

View File

@ -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) */

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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"

View File

@ -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

View File

@ -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) */

View File

@ -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) */

View File

@ -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) */

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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"

View File

@ -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) */

View File

@ -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) */

View File

@ -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

View File

@ -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) */