Commit fcd0fc33 authored by Roger Dingledine's avatar Roger Dingledine
Browse files

flesh out the source file descriptions for doxygen


svn:r4404
parent 691265df
......@@ -6,8 +6,11 @@ const char aes_c_id[] = "$Id$";
/**
* \file aes.c
*
* \brief Implementation of a simple AES counter mode.
* \brief Implements the AES cipher (with 128-bit keys and blocks),
* and a counter-mode stream cipher on top of AES. This code is
* taken from the main Rijndael distribution. (We include this
* because many people are running older versions of OpenSSL without
* AES support.)
**/
#include "orconfig.h"
......
......@@ -4,8 +4,16 @@
/* $Id$ */
const char compat_c_id[] = "$Id$";
/* This is required on rh7 to make strptime not complain.
*/
/**
* \file compat.c
* \brief Wrappers to make calls more portable. This code defines
* functions such as tor_malloc, tor_snprintf, get/set various data types,
* renaming, setting socket options, switching user IDs. It is basically
* where the non-portable items are conditionally included depending on
* the platform.
**/
/* This is required on rh7 to make strptime not complain. */
#define _GNU_SOURCE
#include "orconfig.h"
......
......@@ -4,6 +4,13 @@
/* $Id$ */
const char container_c_id[] = "$Id$";
/**
* \file container.c
* \brief Implements a smartlist (a resizable array) along
* with helper functions to use smartlists. Also includes a
* splay-tree implementation of the string-to-void* map.
**/
#include "compat.h"
#include "util.h"
#include "log.h"
......@@ -17,10 +24,6 @@ const char container_c_id[] = "$Id$";
#include <string.h>
#include <assert.h>
/* =====
* smartlist_t: a simple resizeable array abstraction.
* ===== */
/* All newly allocated smartlists have this capacity.
*/
#define SMARTLIST_DEFAULT_CAPACITY 32
......
......@@ -6,8 +6,8 @@ const char crypto_c_id[] = "$Id$";
/**
* \file crypto.c
*
* \brief Low-level cryptographic functions.
* \brief Wrapper functions to present a consistent interface to
* public-key and symmetric cryptography operations from OpenSSL.
**/
#include "orconfig.h"
......
......@@ -6,7 +6,7 @@
/**
* \file crypto.h
*
* \brief Headers for low-level cryptographic functions.
* \brief Headers for crypto.c
**/
#ifndef __CRYPTO_H
......
......@@ -6,9 +6,8 @@ const char log_c_id[] = "$Id$";
/**
* \file log.c
*
* \brief Functions to send messages to log files or the console.
*/
**/
#include "orconfig.h"
#include <stdarg.h>
......
......@@ -6,7 +6,7 @@
/**
* \file log.h
*
* \brief Headers for logging functions.
* \brief Headers for log.c
**/
#ifndef __LOG_H
......
......@@ -9,7 +9,7 @@
/**
* \file test.h
* \brief Headers for test.c
* \brief Macros used by unit tests.
*/
#include <string.h>
......
......@@ -6,8 +6,7 @@ const char torgzip_c_id[] = "$Id$";
/**
* \file torgzip.c
*
* \brief Simple in-memory gzip implementation.
* \brief A simple in-memory gzip implementation.
**/
#include "orconfig.h"
......
......@@ -6,9 +6,10 @@ const char tortls_c_id[] = "$Id$";
/**
* \file tortls.c
*
* \brief TLS wrappers for Tor.
* \brief Wrapper functions to present a consistent interface to
* TLS, SSL, and X.509 functions from OpenSSL.
**/
/* (Unlike other tor functions, these
* are prefixed with tor_ in order to avoid conflicting with OpenSSL
* functions and variables.)
......
......@@ -6,7 +6,6 @@ const char util_c_id[] = "$Id$";
/**
* \file util.c
*
* \brief Common functions for strings, IO, network, data structures,
* process control.
**/
......
......@@ -7,7 +7,9 @@ const char buffers_c_id[] = "$Id$";
/**
* \file buffers.c
* \brief Abstractions for buffered IO.
* \brief Implements a generic buffer interface. Buffers are
* fairly opaque string holders that can read to or flush from:
* memory, file descriptors, or TLS connections.
**/
#include "or.h"
......
......@@ -7,7 +7,7 @@ const char circuituse_c_id[] = "$Id$";
/**
* \file circuituse.c
* \brief Launch the right sort of circuits, attach streams to them.
* \brief Launch the right sort of circuits and attach streams to them.
**/
#include "or.h"
......
......@@ -7,7 +7,7 @@ const char command_c_id[] = "$Id$";
/**
* \file command.c
* \brief Functions for processing incoming cells
* \brief Functions for processing incoming cells.
**/
/* In-points to command.c:
......
......@@ -4,9 +4,9 @@
/* See LICENSE for licensing information */
/* $Id$ */
const char config_c_id[] = "$Id$";
/**
* \file config.c
*
* \brief Code to parse and interpret configuration files.
**/
......
......@@ -5,9 +5,8 @@ const char control_c_id[] = "$Id$";
/**
* \file control.c
*
* \brief Implementation for Tor's control-socket interface.
*/
**/
#include "or.h"
......
......@@ -6,8 +6,9 @@ const char cpuworker_c_id[] = "$Id$";
/**
* \file cpuworker.c
* \brief Run computation-intensive tasks (generally for crypto) in
* a separate execution context. [OR only.]
* \brief Implements a farm of 'CPU worker' processes to perform
* CPU-intensive tasks in another thread or process, to not
* interrupt the main thread.
*
* Right now, we only use this for processing onionskins.
**/
......
......@@ -8,7 +8,9 @@ const char directory_c_id[] = "$Id$";
/**
* \file directory.c
* \brief Implement directory HTTP protocol.
* \brief Code to send and fetch directories and router
* descriptors via HTTP. Directories use dirserv.c to generate the
* results; clients use routers.c to parse them.
**/
/* In-points to directory.c:
......
......@@ -8,7 +8,8 @@ const char dirserv_c_id[] = "$Id$";
/**
* \file dirserv.c
* \brief Directory server core implementation.
* \brief Directory server core implementation. Manages directory
* contents and generates directories.
**/
/** How far in the future do we allow a router to get? (seconds) */
......
......@@ -6,7 +6,10 @@ const char dns_c_id[] = "$Id$";
/**
* \file dns.c
* \brief Resolve hostnames in separate processes.
* \brief Implements a farm of 'DNS worker' threads or processes to
* perform DNS lookups for onion routers and cache the results.
* [This needs to be done in the background because of the lack of a
* good, ubiquitous asynchronous DNS implementation.]
**/
/* See http://elvin.dstc.com/ListArchive/elvin-dev/archive/2001/09/msg00027.html
......
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