[tor-commits] [tor/maint-0.2.2] Fix up all doxygen warnings other than "foo is not documented"

[nickm@xxxxxxxxxxxxxx]

commit 7f6af7a60281f00fde2e3b3f552edcc5f9311a04
Author: Nick Mathewson <nickm@xxxxxxxxxxxxxx>
Date:   Wed Mar 16 14:47:27 2011 -0400

    Fix up all doxygen warnings other than "foo is not documented"
---
 Doxyfile.in            |    2 +-
 src/common/address.c   |    2 +-
 src/common/torlog.h    |    2 +-
 src/or/circuitbuild.c  |    4 ++--
 src/or/connection_or.c |    2 +-
 src/or/routerparse.h   |    2 +-
 6 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/Doxyfile.in b/Doxyfile.in
index 41f599d..344ee27 100644
--- a/Doxyfile.in
+++ b/Doxyfile.in
@@ -160,7 +160,7 @@ MULTILINE_CPP_IS_BRIEF = NO
 # If set to NO, the detailed description appears after the member 
 # documentation.
 
-DETAILS_AT_TOP         = NO
+# DETAILS_AT_TOP         = NO
 
 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 
 # member inherits the documentation from any documented member that it 
diff --git a/src/common/address.c b/src/common/address.c
index a2780fb..072661b 100644
--- a/src/common/address.c
+++ b/src/common/address.c
@@ -788,7 +788,7 @@ tor_addr_compare(const tor_addr_t *addr1, const tor_addr_t *addr2,
  * Reduce over-specific masks (>128 for ipv6, >32 for ipv4) to 128 or 32.
  *
  * The mask is interpreted relative to <b>addr1</b>, so that if a is
- * ::ffff:1.2.3.4, and b is 3.4.5.6,
+ * \::ffff:1.2.3.4, and b is 3.4.5.6,
  * tor_addr_compare_masked(a,b,100,CMP_SEMANTIC) is the same as
  * -tor_addr_compare_masked(b,a,4,CMP_SEMANTIC).
  *
diff --git a/src/common/torlog.h b/src/common/torlog.h
index 791e363..9b98bec 100644
--- a/src/common/torlog.h
+++ b/src/common/torlog.h
@@ -5,7 +5,7 @@
 /* See LICENSE for licensing information */
 
 /**
- * \file log.h
+ * \file torlog.h
  *
  * \brief Headers for log.c
  **/
diff --git a/src/or/circuitbuild.c b/src/or/circuitbuild.c
index a54f232..83ac7a5 100644
--- a/src/or/circuitbuild.c
+++ b/src/or/circuitbuild.c
@@ -457,7 +457,7 @@ circuit_build_times_rewind_history(circuit_build_times_t *cbt, int n)
  * Add a new build time value <b>time</b> to the set of build times. Time
  * units are milliseconds.
  *
- * circuit_build_times <b>cbt</a> is a circular array, so loop around when
+ * circuit_build_times <b>cbt</b> is a circular array, so loop around when
  * array is full.
  */
 int
@@ -655,7 +655,7 @@ circuit_build_times_update_state(circuit_build_times_t *cbt,
 /**
  * Shuffle the build times array.
  *
- * Stolen from http://en.wikipedia.org/wiki/Fisher\u2013Yates_shuffle
+ * Adapted from http://en.wikipedia.org/wiki/Fisher-Yates_shuffle
  */
 static void
 circuit_build_times_shuffle_and_store_array(circuit_build_times_t *cbt,
diff --git a/src/or/connection_or.c b/src/or/connection_or.c
index 2d24444..ff863fd 100644
--- a/src/or/connection_or.c
+++ b/src/or/connection_or.c
@@ -467,7 +467,7 @@ connection_or_init_conn_from_address(or_connection_t *conn,
  * Requires that both input connections are open; not is_bad_for_new_circs,
  * and not impossibly non-canonical.
  *
- * If </b>forgive_new_connections</b> is true, then we do not call
+ * If <b>forgive_new_connections</b> is true, then we do not call
  * <b>a</b>better than <b>b</b> simply because b has no circuits,
  * unless b is also relatively old.
  */
diff --git a/src/or/routerparse.h b/src/or/routerparse.h
index bde7800..3499f18 100644
--- a/src/or/routerparse.h
+++ b/src/or/routerparse.h
@@ -5,7 +5,7 @@
 /* See LICENSE for licensing information */
 
 /**
- * \file routerpase.h
+ * \file routerparse.h
  * \brief Header file for routerparse.c.
  **/
 



_______________________________________________
tor-commits mailing list
tor-commits@xxxxxxxxxxxxxxxxxxxx
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-commits