summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2011-03-16 17:16:54 -0400
committerNick Mathewson <nickm@torproject.org>2011-03-16 17:16:54 -0400
commitb1b6552251c87db6c4fd226add8ae8bdb9327981 (patch)
tree0596fbac288b6770396d18e777981c687f6dd3db
parent57b954293e3880f3b39d2f0f0f7710250e8ffc5f (diff)
parentcf399f1034cec6be2b7a98cb82a8607634e120f6 (diff)
downloadtor-b1b6552251c87db6c4fd226add8ae8bdb9327981.tar.gz
tor-b1b6552251c87db6c4fd226add8ae8bdb9327981.zip
Merge remote-tracking branch 'origin/maint-0.2.2'
Conflicts: src/common/crypto.c
-rw-r--r--changes/doxygen6
-rw-r--r--src/common/crypto.c1
-rw-r--r--src/common/log.c6
-rw-r--r--src/test/test_crypto.c6
-rw-r--r--src/test/test_dir.c6
5 files changed, 16 insertions, 9 deletions
diff --git a/changes/doxygen b/changes/doxygen
new file mode 100644
index 0000000000..5e5fcd12d6
--- /dev/null
+++ b/changes/doxygen
@@ -0,0 +1,6 @@
+ o Documentation changes
+ - Modernize the doxygen configuration file slightly. Fixes bug 2707.
+ - Resolve all doxygen warnings except those for missing documentation.
+ Fixes bug 2705.
+ - Add doxygen documentation for more functions, fields, and types.
+
diff --git a/src/common/crypto.c b/src/common/crypto.c
index fd0a494e76..6fed55a27b 100644
--- a/src/common/crypto.c
+++ b/src/common/crypto.c
@@ -2711,4 +2711,3 @@ setup_openssl_threading(void)
#endif
/** @} */
-
diff --git a/src/common/log.c b/src/common/log.c
index 52c41fb3ce..a073c827e0 100644
--- a/src/common/log.c
+++ b/src/common/log.c
@@ -409,7 +409,7 @@ logv(int severity, log_domain_mask_t domain, const char *funcname,
/** Output a message to the log. It gets logged to all logfiles that
* care about messages with <b>severity</b> in <b>domain</b>. The content
- * if formatted printf style
+ * is formatted printf style basedc on <b>format</b> and extra arguments.
* */
void
tor_log(int severity, log_domain_mask_t domain, const char *format, ...)
@@ -425,8 +425,8 @@ tor_log(int severity, log_domain_mask_t domain, const char *format, ...)
/** Output a message to the log, prefixed with a function name <b>fn</b>. */
#ifdef __GNUC__
/** GCC-based implementation of the log_fn backend, used when we have
- * variadic macros. All arguments are as for log_fn, except for <b>fn</b>, which
- * is the name of the calling functions. */
+ * variadic macros. All arguments are as for log_fn, except for
+ * <b>fn</b>, which is the name of the calling functions. */
void
_log_fn(int severity, log_domain_mask_t domain, const char *fn,
const char *format, ...)
diff --git a/src/test/test_crypto.c b/src/test/test_crypto.c
index 6ea7f295ed..781081a4ad 100644
--- a/src/test/test_crypto.c
+++ b/src/test/test_crypto.c
@@ -384,12 +384,14 @@ test_crypto_pk(void)
/* Now try signing. */
strlcpy(data1, "Ossifrage", 1024);
test_eq(128, crypto_pk_private_sign(pk1, data2, sizeof(data2), data1, 10));
- test_eq(10, crypto_pk_public_checksig(pk1, data3, sizeof(data3), data2, 128));
+ test_eq(10,
+ crypto_pk_public_checksig(pk1, data3, sizeof(data3), data2, 128));
test_streq(data3, "Ossifrage");
/* Try signing digests. */
test_eq(128, crypto_pk_private_sign_digest(pk1, data2, sizeof(data2),
data1, 10));
- test_eq(20, crypto_pk_public_checksig(pk1, data3, sizeof(data3), data2, 128));
+ test_eq(20,
+ crypto_pk_public_checksig(pk1, data3, sizeof(data3), data2, 128));
test_eq(0, crypto_pk_public_checksig_digest(pk1, data1, 10, data2, 128));
test_eq(-1, crypto_pk_public_checksig_digest(pk1, data1, 11, data2, 128));
diff --git a/src/test/test_dir.c b/src/test/test_dir.c
index 161eda9cd7..4b86be4963 100644
--- a/src/test/test_dir.c
+++ b/src/test/test_dir.c
@@ -748,11 +748,11 @@ test_dir_v3_networkstatus(void)
sign_skey_leg1 = pk_generate(4);
test_assert(!crypto_pk_read_private_key_from_string(sign_skey_1,
- AUTHORITY_SIGNKEY_1, -1));
+ AUTHORITY_SIGNKEY_1, -1));
test_assert(!crypto_pk_read_private_key_from_string(sign_skey_2,
- AUTHORITY_SIGNKEY_2, -1));
+ AUTHORITY_SIGNKEY_2, -1));
test_assert(!crypto_pk_read_private_key_from_string(sign_skey_3,
- AUTHORITY_SIGNKEY_3, -1));
+ AUTHORITY_SIGNKEY_3, -1));
test_assert(!crypto_pk_cmp_keys(sign_skey_1, cert1->signing_key));
test_assert(!crypto_pk_cmp_keys(sign_skey_2, cert2->signing_key));