From 509d2912dcc533ececaa9f09f96271ae57a7f275 Mon Sep 17 00:00:00 2001 From: Roger Dingledine Date: Sat, 9 Feb 2008 03:11:10 +0000 Subject: doxygen and other cleanups svn:r13440 --- src/common/aes.c | 4 ++-- src/common/crypto.c | 29 +++++++++++++++-------------- src/common/mempool.c | 2 +- src/common/mempool.h | 6 +++--- src/common/tortls.c | 2 +- src/common/util.c | 2 +- 6 files changed, 23 insertions(+), 22 deletions(-) (limited to 'src/common') diff --git a/src/common/aes.c b/src/common/aes.c index cd8317dd11..96d5ca4126 100644 --- a/src/common/aes.c +++ b/src/common/aes.c @@ -286,7 +286,7 @@ aes_crypt(aes_cnt_cipher_t *cipher, const char *input, size_t len, /* XXXX This function is up to 5% of our runtime in some profiles; * we should look into unrolling some of the loops; taking advantage - * of alignmement, using a bigger buffer, and so on. Not till after 0.1.2.x, + * of alignment, using a bigger buffer, and so on. Not till after 0.1.2.x, * though. */ int c = cipher->pos; if (PREDICT_UNLIKELY(!len)) return; @@ -322,7 +322,7 @@ aes_crypt_inplace(aes_cnt_cipher_t *cipher, char *data, size_t len) /* XXXX This function is up to 5% of our runtime in some profiles; * we should look into unrolling some of the loops; taking advantage - * of alignmement, using a bigger buffer, and so on. Not till after 0.1.2.x, + * of alignment, using a bigger buffer, and so on. Not till after 0.1.2.x, * though. */ int c = cipher->pos; if (PREDICT_UNLIKELY(!len)) return; diff --git a/src/common/crypto.c b/src/common/crypto.c index 01e32524c6..cd10e649c4 100644 --- a/src/common/crypto.c +++ b/src/common/crypto.c @@ -1550,12 +1550,12 @@ crypto_dh_compute_secret(crypto_dh_env_t *dh, goto error; } secret_len = result; - /* sometimes secret_len might be less than 128, e.g., 127. that's ok. */ + /* sometimes secret_len might be less than 128, e.g., 127. that's ok. -RD */ /* Actually, http://www.faqs.org/rfcs/rfc2631.html says: * Leading zeros MUST be preserved, so that ZZ occupies as many * octets as p. For instance, if p is 1024 bits, ZZ should be 128 * bytes long. - * What are the security implications here? + * XXX021 What are the security implications here? -NM */ if (crypto_expand_key_material(secret_tmp, secret_len, secret_out, secret_bytes_out)<0) @@ -1578,7 +1578,7 @@ crypto_dh_compute_secret(crypto_dh_env_t *dh, /** Given key_in_len bytes of negotiated randomness in key_in * ("K"), expand it into key_out_len bytes of negotiated key material in - * key_out by taking the first key_out_len bytes of + * key_out by taking the first key_out_len bytes of * H(K | [00]) | H(K | [01]) | .... * * Return 0 on success, -1 on failure. @@ -1710,7 +1710,7 @@ crypto_seed_rng(void) #endif } -/** Write n bytes of strong random data to to. Return 0 on +/** Write n bytes of strong random data to to. Return 0 on * success, -1 on failure. */ int @@ -1725,7 +1725,7 @@ crypto_rand(char *to, size_t n) } /** Return a pseudorandom integer, chosen uniformly from the values - * between 0 and max-1. */ + * between 0 and max-1. */ int crypto_rand_int(unsigned int max) { @@ -1746,8 +1746,8 @@ crypto_rand_int(unsigned int max) } } -/** Return a pseudorandom integer, chosen uniformly from the values - * between 0 and max-1. */ +/** Return a pseudorandom 64-bit integer, chosen uniformly from the values + * between 0 and max-1. */ uint64_t crypto_rand_uint64(uint64_t max) { @@ -1768,9 +1768,10 @@ crypto_rand_uint64(uint64_t max) } } -/** Generate and return a new random hostname starting with prefix, ending - * with suffix, and containing between min_rand_len and max_rand_len random - * base32 characters between. */ +/** Generate and return a new random hostname starting with prefix, + * ending with suffix, and containing no less than + * min_rand_len and no more than max_rand_len random base32 + * characters between. */ char * crypto_random_hostname(int min_rand_len, int max_rand_len, const char *prefix, const char *suffix) @@ -1799,8 +1800,8 @@ crypto_random_hostname(int min_rand_len, int max_rand_len, const char *prefix, return result; } -/** Return a randomly chosen element of sl; or NULL if sl is empty. - */ +/** Return a randomly chosen element of sl; or NULL if sl + * is empty. */ void * smartlist_choose(const smartlist_t *sl) { @@ -1811,7 +1812,7 @@ smartlist_choose(const smartlist_t *sl) return NULL; /* no elements to choose from */ } -/** Scramble the elements of sl into a random order. */ +/** Scramble the elements of sl into a random order. */ void smartlist_shuffle(smartlist_t *sl) { @@ -1834,7 +1835,7 @@ smartlist_shuffle(smartlist_t *sl) int base64_encode(char *dest, size_t destlen, const char *src, size_t srclen) { - /* XXXX we might want to rewrite this along the lines of base64_decode, if + /* FFFF we might want to rewrite this along the lines of base64_decode, if * it ever shows up in the profile. */ EVP_ENCODE_CTX ctx; int len, ret; diff --git a/src/common/mempool.c b/src/common/mempool.c index 43f10c1e44..7e2369fc43 100644 --- a/src/common/mempool.c +++ b/src/common/mempool.c @@ -204,7 +204,7 @@ add_newly_used_chunk_to_used_list(mp_pool_t *pool, mp_chunk_t *chunk) ASSERT(!chunk->prev); } -/** Return an newly allocated item from pool. */ +/** Return a newly allocated item from pool. */ void * mp_pool_get(mp_pool_t *pool) { diff --git a/src/common/mempool.h b/src/common/mempool.h index 2c5c925f77..2344c01cba 100644 --- a/src/common/mempool.h +++ b/src/common/mempool.h @@ -50,11 +50,11 @@ struct mp_pool_t { * padding. */ size_t item_alloc_size; #ifdef MEMPOOL_STATS - /** Total number of items allocated ever */ + /** Total number of items allocated ever. */ uint64_t total_items_allocated; - /** Total number of chunks allocated ever */ + /** Total number of chunks allocated ever. */ uint64_t total_chunks_allocated; - /** Total number of chunks freed ever */ + /** Total number of chunks freed ever. */ uint64_t total_chunks_freed; #endif }; diff --git a/src/common/tortls.c b/src/common/tortls.c index 55bdfcd763..51ce4a6c3a 100644 --- a/src/common/tortls.c +++ b/src/common/tortls.c @@ -322,7 +322,7 @@ always_accept_verify_cb(int preverify_ok, return 1; } -/** Return a newly allocated X509 name with commonName cname */ +/** Return a newly allocated X509 name with commonName cname. */ static X509_NAME * tor_x509_name_new(const char *cname) { diff --git a/src/common/util.c b/src/common/util.c index 0631fdcb8f..8d1d08a8be 100644 --- a/src/common/util.c +++ b/src/common/util.c @@ -707,7 +707,7 @@ tor_parse_long(const char *s, int base, long min, long max, CHECK_STRTOX_RESULT(); } -/** As tor_parse_long, but return an unsigned long. */ +/** As tor_parse_long(), but return an unsigned long. */ unsigned long tor_parse_ulong(const char *s, int base, unsigned long min, unsigned long max, int *ok, char **next) -- cgit v1.2.3-54-g00ecf