Add a brief file-level description for everything in src/common
This commit is contained in:
parent
fe6ca826df
commit
23f8c9b32f
|
@ -1,6 +1,13 @@
|
|||
/* Copyright (c) 2013-2015, The Tor Project, Inc. */
|
||||
/* See LICENSE for licensing information */
|
||||
|
||||
/**
|
||||
* \file backtrace.c
|
||||
*
|
||||
* \brief Functions to produce backtraces on bugs, crashes, or assertion
|
||||
* failures.
|
||||
*/
|
||||
|
||||
#define __USE_GNU
|
||||
#define _GNU_SOURCE 1
|
||||
|
||||
|
|
|
@ -3,6 +3,13 @@
|
|||
* Copyright (c) 2007-2015, The Tor Project, Inc. */
|
||||
/* See LICENSE for licensing information */
|
||||
|
||||
/**
|
||||
* \file compat_pthreads.c
|
||||
*
|
||||
* \brief Implementation for the pthreads-based multithreading backend
|
||||
* functions.
|
||||
*/
|
||||
|
||||
#define _GNU_SOURCE
|
||||
|
||||
#include "orconfig.h"
|
||||
|
|
|
@ -3,6 +3,14 @@
|
|||
* Copyright (c) 2007-2015, The Tor Project, Inc. */
|
||||
/* See LICENSE for licensing information */
|
||||
|
||||
/**
|
||||
* \file compat_threads.c
|
||||
*
|
||||
* \brief Cross-platform threading and inter-thread communication logic.
|
||||
* (Platform-specific parts are written in the other compat_*threads
|
||||
* modules.)
|
||||
*/
|
||||
|
||||
#define _GNU_SOURCE
|
||||
|
||||
#include "orconfig.h"
|
||||
|
|
|
@ -3,6 +3,13 @@
|
|||
* Copyright (c) 2007-2015, The Tor Project, Inc. */
|
||||
/* See LICENSE for licensing information */
|
||||
|
||||
/**
|
||||
* \file compat_winthreads.c
|
||||
*
|
||||
* \brief Implementation for the windows-based multithreading backend
|
||||
* functions.
|
||||
*/
|
||||
|
||||
#ifdef _WIN32
|
||||
|
||||
#include "compat.h"
|
||||
|
|
|
@ -1,7 +1,11 @@
|
|||
/* Copyright (c) 2012-2015, The Tor Project, Inc. */
|
||||
/* See LICENSE for licensing information */
|
||||
|
||||
/* Wrapper code for a curve25519 implementation. */
|
||||
/**
|
||||
* \file crypto_curve25519.c
|
||||
*
|
||||
* \brief Wrapper code for a curve25519 implementation.
|
||||
*/
|
||||
|
||||
#define CRYPTO_CURVE25519_PRIVATE
|
||||
#include "orconfig.h"
|
||||
|
|
|
@ -1,7 +1,11 @@
|
|||
/* Copyright (c) 2013-2015, The Tor Project, Inc. */
|
||||
/* See LICENSE for licensing information */
|
||||
|
||||
/* Wrapper code for an ed25519 implementation. */
|
||||
/**
|
||||
* \file crypto_ed25519.c
|
||||
*
|
||||
* \brief Wrapper code for an ed25519 implementation.
|
||||
*/
|
||||
|
||||
#include "orconfig.h"
|
||||
#ifdef HAVE_SYS_STAT_H
|
||||
|
|
|
@ -4,7 +4,11 @@
|
|||
* Copyright (c) 2007-2015, The Tor Project, Inc. */
|
||||
/* See LICENSE for licensing information */
|
||||
|
||||
/* Formatting and parsing code for crypto-related data structures. */
|
||||
/**
|
||||
* \file crypto_format.c
|
||||
*
|
||||
* \brief Formatting and parsing code for crypto-related data structures.
|
||||
*/
|
||||
|
||||
#include "orconfig.h"
|
||||
#ifdef HAVE_SYS_STAT_H
|
||||
|
|
|
@ -1,3 +1,12 @@
|
|||
/* Copyright (c) 2014-2016, The Tor Project, Inc. */
|
||||
/* See LICENSE for licensing information */
|
||||
|
||||
/**
|
||||
* \file crypto_pwbox.c
|
||||
*
|
||||
* \brief Code for encrypting secrets in a password-protected form and saving
|
||||
* them to disk.
|
||||
*/
|
||||
|
||||
#include "crypto.h"
|
||||
#include "crypto_s2k.h"
|
||||
|
|
|
@ -4,6 +4,12 @@
|
|||
* Copyright (c) 2007-2015, The Tor Project, Inc. */
|
||||
/* See LICENSE for licensing information */
|
||||
|
||||
/**
|
||||
* \file crypto_s2k.c
|
||||
*
|
||||
* \brief Functions for deriving keys from human-readable passphrases.
|
||||
*/
|
||||
|
||||
#define CRYPTO_S2K_PRIVATE
|
||||
|
||||
#include "crypto.h"
|
||||
|
|
|
@ -4,6 +4,13 @@
|
|||
* Copyright (c) 2007-2015, The Tor Project, Inc. */
|
||||
/* See LICENSE for licensing information */
|
||||
|
||||
/**
|
||||
* \file util_format.c
|
||||
*
|
||||
* \brief Miscellaneous functions for encoding and decoding various things
|
||||
* in base{16,32,64}.
|
||||
*/
|
||||
|
||||
#include "orconfig.h"
|
||||
#include "torlog.h"
|
||||
#include "util.h"
|
||||
|
|
|
@ -1,6 +1,13 @@
|
|||
/* copyright (c) 2013-2015, The Tor Project, Inc. */
|
||||
/* See LICENSE for licensing information */
|
||||
|
||||
/**
|
||||
* \file workqueue.c
|
||||
*
|
||||
* \brief Implements worker threads, queues of work for them, and mechanisms
|
||||
* for them to send answers back to the main thread.
|
||||
*/
|
||||
|
||||
#include "orconfig.h"
|
||||
#include "compat.h"
|
||||
#include "compat_threads.h"
|
||||
|
|
Loading…
Reference in New Issue