Commit 4f42c923 authored by Nick Mathewson's avatar Nick Mathewson 🎨
Browse files

File-level summary documentation for src/lib/*/*.[ch]

parent 4793d913
......@@ -3,6 +3,12 @@
* Copyright (c) 2007-2018, The Tor Project, Inc. */
/* See LICENSE for licensing information */
/**
* \file compat_compiler.h
* \brief Utility macros to handle different features and behavior in different
* compilers.
**/
#ifndef TOR_COMPAT_COMPILER_H
#define TOR_COMPAT_COMPILER_H
......
......@@ -5,18 +5,13 @@
/**
* \file torint.h
* \brief Header file to define uint32_t and friends
*
* \brief Integer definitions used throughout Tor.
**/
#ifndef TOR_TORINT_H
#define TOR_TORINT_H
/**
* \file torint.h
*
* \brief Integer definitions used throughout Tor.
**/
#include "orconfig.h"
#include <stdint.h>
......
/* Copyright (c) 2012-2018, The Tor Project, Inc. */
/* See LICENSE for licensing information */
/**
* \file crypto_curve25519.h
* \brief Header for crypto_curve25519.c
**/
#ifndef TOR_CRYPTO_CURVE25519_H
#define TOR_CRYPTO_CURVE25519_H
......
/* Copyright (c) 2012-2018, The Tor Project, Inc. */
/* See LICENSE for licensing information */
/**
* \file crypto_ed25519.h
* \brief Header for crypto_ed25519.c
**/
#ifndef TOR_CRYPTO_ED25519_H
#define TOR_CRYPTO_ED25519_H
......
......@@ -4,6 +4,11 @@
* Copyright (c) 2007-2018, The Tor Project, Inc. */
/* See LICENSE for licensing information */
/**
* \file crypto_format.h
* \brief Header for crypto_format.c
**/
#ifndef TOR_CRYPTO_FORMAT_H
#define TOR_CRYPTO_FORMAT_H
......
......@@ -5,7 +5,7 @@
/* See LICENSE for licensing information */
/**
* \file crypto_openssl.c
* \file crypto_openssl_mgt.c
*
* \brief Block of functions related to operations from OpenSSL.
**/
......
......@@ -5,9 +5,9 @@
/* See LICENSE for licensing information */
/**
* \file crypto_openssl.h
* \file crypto_openssl_mgt.h
*
* \brief Headers for crypto_openssl.c
* \brief Headers for crypto_openssl_mgt.c
**/
#ifndef TOR_CRYPTO_OPENSSL_H
......
......@@ -4,6 +4,15 @@
* Copyright (c) 2007-2018, The Tor Project, Inc. */
/* See LICENSE for licensing information */
/**
* \file dh_sizes.h
* \brief Definitions for sizes of Diffie-Hellman groups elements in Z_p.
*
* Tor uses these definitions throughout its codebase, even in parts that
* don't actually do any Diffie-Hellman calculations.
**/
#ifndef TOR_DH_SIZES_H
#define TOR_DH_SIZES_H
......
......@@ -4,6 +4,15 @@
* Copyright (c) 2007-2018, The Tor Project, Inc. */
/* See LICENSE for licensing information */
/**
* \file x25519_sizes.h
* \brief Definitions for sizes of x25519 keys and elements.
*
* Tor uses these definitions throughout its codebase, even in parts that
* don't actually do any x25519 calculations.
**/
#ifndef TOR_X25519_SIZES_H
#define TOR_X25519_SIZES_H
......
/* Copyright (c) 2009-2018, The Tor Project, Inc. */
/* See LICENSE for licensing information */
/**
* \file compat_libevent.h
* \brief Header for compat_libevent.c
**/
#ifndef TOR_COMPAT_LIBEVENT_H
#define TOR_COMPAT_LIBEVENT_H
......
/* Copyright (c) 2016-2018, The Tor Project, Inc. */
/* See LICENSE for licensing information */
/**
* \file timers.h
* \brief Header for timers.c
**/
#ifndef TOR_TIMERS_H
#define TOR_TIMERS_H
......@@ -28,4 +33,3 @@ STATIC void timers_run_pending(void);
#endif
#endif /* !defined(TOR_TIMERS_H) */
......@@ -2,8 +2,8 @@
/* See LICENSE for licensing information */
/**
* \file token_bucket_rw.h
* \brief Headers for token_bucket_rw.c
* \file token_bucket.h
* \brief Headers for token_bucket.c
**/
#ifndef TOR_TOKEN_BUCKET_H
......@@ -115,4 +115,3 @@ STATIC uint32_t rate_per_sec_to_rate_per_step(uint32_t rate);
#endif
#endif /* TOR_TOKEN_BUCKET_H */
/* Copyright (c) 2013-2018, The Tor Project, Inc. */
/* See LICENSE for licensing information */
/**
* \file workqueue.h
* \brief Header for workqueue.c
**/
#ifndef TOR_WORKQUEUE_H
#define TOR_WORKQUEUE_H
......
......@@ -3,6 +3,11 @@
* Copyright (c) 2007-2018, The Tor Project, Inc. */
/* See LICENSE for licensing information */
/**
* \file escape.c
* \brief Escape untrusted strings before sending them to the log.
**/
#include "lib/log/escape.h"
#include "lib/log/util_bug.h"
#include "lib/string/compat_ctype.h"
......
......@@ -4,6 +4,11 @@
* Copyright (c) 2007-2018, The Tor Project, Inc. */
/* See LICENSE for licensing information */
/**
* \file escape.h
* \brief Header for escape.c
**/
#ifndef TOR_ESCAPE_H
#define TOR_ESCAPE_H
......
......@@ -3,6 +3,11 @@
* Copyright (c) 2007-2018, The Tor Project, Inc. */
/* See LICENSE for licensing information */
/**
* \file ratelim.c
* \brief Summarize similar messages that would otherwise flood the logs.
**/
#include "lib/log/ratelim.h"
#include "lib/malloc/util_malloc.h"
#include "lib/string/printf.h"
......
......@@ -3,6 +3,11 @@
* Copyright (c) 2007-2018, The Tor Project, Inc. */
/* See LICENSE for licensing information */
/**
* \file ratelim.h
* \brief Summarize similar messages that would otherwise flood the logs.
**/
#ifndef TOR_RATELIM_H
#define TOR_RATELIM_H
......
......@@ -3,6 +3,11 @@
* Copyright (c) 2007-2018, The Tor Project, Inc. */
/* See LICENSE for licensing information */
/**
* \file win32err.c
* \brief Convert windows error codes to useful C strings.
**/
#ifdef _WIN32
#include "orconfig.h"
#include "lib/log/win32err.h"
......
......@@ -3,6 +3,11 @@
* Copyright (c) 2007-2018, The Tor Project, Inc. */
/* See LICENSE for licensing information */
/**
* \file win32err.h
* \brief Header for win32err.c
**/
#ifndef TOR_WIN32ERR_H
#define TOR_WIN32ERR_H
......
......@@ -4,6 +4,11 @@
* Copyright (c) 2007-2018, The Tor Project, Inc. */
/* See LICENSE for licensing information */
/**
* \file buffers_net.c
* \brief Read and write data on a buf_t object.
**/
#define BUFFERS_PRIVATE
#include "lib/net/buffers_net.h"
#include "lib/container/buffers.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