[or-cvs] flesh out the source file descriptions for doxygen
arma at seul.org
arma at seul.org
Sat Jun 11 05:31:17 UTC 2005
Update of /home2/or/cvsroot/tor/src/common
In directory moria:/home/arma/work/onion/cvs/tor/src/common
Modified Files:
aes.c compat.c container.c crypto.c crypto.h log.c log.h
test.h torgzip.c tortls.c util.c
Log Message:
flesh out the source file descriptions for doxygen
Index: aes.c
===================================================================
RCS file: /home2/or/cvsroot/tor/src/common/aes.c,v
retrieving revision 1.20
retrieving revision 1.21
diff -u -d -r1.20 -r1.21
--- aes.c 9 Jun 2005 19:03:31 -0000 1.20
+++ aes.c 11 Jun 2005 05:31:15 -0000 1.21
@@ -6,8 +6,11 @@
/**
* \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"
Index: compat.c
===================================================================
RCS file: /home2/or/cvsroot/tor/src/common/compat.c,v
retrieving revision 1.49
retrieving revision 1.50
diff -u -d -r1.49 -r1.50
--- compat.c 9 Jun 2005 19:03:31 -0000 1.49
+++ compat.c 11 Jun 2005 05:31:15 -0000 1.50
@@ -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"
Index: container.c
===================================================================
RCS file: /home2/or/cvsroot/tor/src/common/container.c,v
retrieving revision 1.27
retrieving revision 1.28
diff -u -d -r1.27 -r1.28
--- container.c 9 Jun 2005 19:03:31 -0000 1.27
+++ container.c 11 Jun 2005 05:31:15 -0000 1.28
@@ -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 @@
#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
Index: crypto.c
===================================================================
RCS file: /home2/or/cvsroot/tor/src/common/crypto.c,v
retrieving revision 1.139
retrieving revision 1.140
diff -u -d -r1.139 -r1.140
--- crypto.c 9 Jun 2005 19:03:31 -0000 1.139
+++ crypto.c 11 Jun 2005 05:31:15 -0000 1.140
@@ -6,8 +6,8 @@
/**
* \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"
Index: crypto.h
===================================================================
RCS file: /home2/or/cvsroot/tor/src/common/crypto.h,v
retrieving revision 1.63
retrieving revision 1.64
diff -u -d -r1.63 -r1.64
--- crypto.h 9 Jun 2005 19:03:31 -0000 1.63
+++ crypto.h 11 Jun 2005 05:31:15 -0000 1.64
@@ -6,7 +6,7 @@
/**
* \file crypto.h
*
- * \brief Headers for low-level cryptographic functions.
+ * \brief Headers for crypto.c
**/
#ifndef __CRYPTO_H
Index: log.c
===================================================================
RCS file: /home2/or/cvsroot/tor/src/common/log.c,v
retrieving revision 1.95
retrieving revision 1.96
diff -u -d -r1.95 -r1.96
--- log.c 9 Jun 2005 19:03:31 -0000 1.95
+++ log.c 11 Jun 2005 05:31:15 -0000 1.96
@@ -6,9 +6,8 @@
/**
* \file log.c
- *
* \brief Functions to send messages to log files or the console.
- */
+ **/
#include "orconfig.h"
#include <stdarg.h>
Index: log.h
===================================================================
RCS file: /home2/or/cvsroot/tor/src/common/log.h,v
retrieving revision 1.46
retrieving revision 1.47
diff -u -d -r1.46 -r1.47
--- log.h 9 Jun 2005 19:03:31 -0000 1.46
+++ log.h 11 Jun 2005 05:31:15 -0000 1.47
@@ -6,7 +6,7 @@
/**
* \file log.h
*
- * \brief Headers for logging functions.
+ * \brief Headers for log.c
**/
#ifndef __LOG_H
Index: test.h
===================================================================
RCS file: /home2/or/cvsroot/tor/src/common/test.h,v
retrieving revision 1.22
retrieving revision 1.23
diff -u -d -r1.22 -r1.23
--- test.h 9 Jun 2005 19:03:31 -0000 1.22
+++ test.h 11 Jun 2005 05:31:15 -0000 1.23
@@ -9,7 +9,7 @@
/**
* \file test.h
- * \brief Headers for test.c
+ * \brief Macros used by unit tests.
*/
#include <string.h>
Index: torgzip.c
===================================================================
RCS file: /home2/or/cvsroot/tor/src/common/torgzip.c,v
retrieving revision 1.17
retrieving revision 1.18
diff -u -d -r1.17 -r1.18
--- torgzip.c 9 Jun 2005 19:03:31 -0000 1.17
+++ torgzip.c 11 Jun 2005 05:31:15 -0000 1.18
@@ -6,8 +6,7 @@
/**
* \file torgzip.c
- *
- * \brief Simple in-memory gzip implementation.
+ * \brief A simple in-memory gzip implementation.
**/
#include "orconfig.h"
Index: tortls.c
===================================================================
RCS file: /home2/or/cvsroot/tor/src/common/tortls.c,v
retrieving revision 1.96
retrieving revision 1.97
diff -u -d -r1.96 -r1.97
--- tortls.c 9 Jun 2005 19:03:31 -0000 1.96
+++ tortls.c 11 Jun 2005 05:31:15 -0000 1.97
@@ -6,9 +6,10 @@
/**
* \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.)
Index: util.c
===================================================================
RCS file: /home2/or/cvsroot/tor/src/common/util.c,v
retrieving revision 1.209
retrieving revision 1.210
diff -u -d -r1.209 -r1.210
--- util.c 9 Jun 2005 19:03:31 -0000 1.209
+++ util.c 11 Jun 2005 05:31:15 -0000 1.210
@@ -6,7 +6,6 @@
/**
* \file util.c
- *
* \brief Common functions for strings, IO, network, data structures,
* process control.
**/
More information about the tor-commits
mailing list