Commit 68f80860 authored by Nick Mathewson's avatar Nick Mathewson 🌉
Browse files

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.
parent 30c6ab51
......@@ -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
......
......@@ -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) */
......@@ -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"
......
......@@ -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
......
......@@ -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"
......
/* 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"
......
......@@ -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
......
......@@ -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"
......
......@@ -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
......
......@@ -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"
......
......@@ -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
......
......@@ -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"
......
......@@ -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
......
/* 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
......
......@@ -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) */
/* 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
......
......@@ -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) */
......@@ -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) */
/* 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"
......
/* 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
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment