@@ -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. */
+ * \file compat_pthreads.c
+ * \brief Implementation for the pthreads-based multithreading backend
+ * functions.
#define _GNU_SOURCE
#include "orconfig.h"
@@ -3,6 +3,14 @@
+ * \file compat_threads.c
+ * \brief Cross-platform threading and inter-thread communication logic.
+ * (Platform-specific parts are written in the other compat_*threads
+ * modules.)
+ * \file compat_winthreads.c
+ * \brief Implementation for the windows-based multithreading backend
#ifdef _WIN32
#include "compat.h"
@@ -1,7 +1,11 @@
/* Copyright (c) 2012-2015, The Tor Project, Inc. */
-/* Wrapper code for a curve25519 implementation. */
+ * \file crypto_curve25519.c
+ * \brief Wrapper code for a curve25519 implementation.
#define CRYPTO_CURVE25519_PRIVATE
-/* Wrapper code for an ed25519 implementation. */
+ * \file crypto_ed25519.c
+ * \brief Wrapper code for an ed25519 implementation.
#ifdef HAVE_SYS_STAT_H
@@ -4,7 +4,11 @@
-/* Formatting and parsing code for crypto-related data structures. */
+ * \file crypto_format.c
+ * \brief Formatting and parsing code for crypto-related data structures.
@@ -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 @@
+ * \file crypto_s2k.c
+ * \brief Functions for deriving keys from human-readable passphrases.
#define CRYPTO_S2K_PRIVATE
@@ -4,6 +4,13 @@
+ * \file util_format.c
+ * \brief Miscellaneous functions for encoding and decoding various things
+ * in base{16,32,64}.
#include "torlog.h"
#include "util.h"
/* copyright (c) 2013-2015, The Tor Project, Inc. */
+ * \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 "compat_threads.h"