sarah
/
tor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Fix up all doxygen warnings other than "foo is not documented"

This commit is contained in:
Nick Mathewson 2011-03-16 14:47:27 -04:00
parent 2def9e0a6e
commit 7f6af7a602
6 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Doxyfile.in
View File

@ -160,7 +160,7 @@ MULTILINE_CPP_IS_BRIEF = NO
# If set to NO, the detailed description appears after the member # If set to NO, the detailed description appears after the member
# documentation. # documentation.
DETAILS_AT_TOP = NO # DETAILS_AT_TOP = NO
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
# member inherits the documentation from any documented member that it # member inherits the documentation from any documented member that it

2
src/common/address.c
View File

@ -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. * 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 * 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(a,b,100,CMP_SEMANTIC) is the same as
* -tor_addr_compare_masked(b,a,4,CMP_SEMANTIC). * -tor_addr_compare_masked(b,a,4,CMP_SEMANTIC).
* *

2
src/common/torlog.h
View File

@ -5,7 +5,7 @@
/* See LICENSE for licensing information */ /* See LICENSE for licensing information */
/** /**
* \file log.h * \file torlog.h
* *
* \brief Headers for log.c * \brief Headers for log.c
**/ **/

4
src/or/circuitbuild.c
View File

@ -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 * Add a new build time value <b>time</b> to the set of build times. Time
* units are milliseconds. * 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. * array is full.
*/ */
int int
@ -655,7 +655,7 @@ circuit_build_times_update_state(circuit_build_times_t *cbt,
/** /**
* Shuffle the build times array. * 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 static void
circuit_build_times_shuffle_and_store_array(circuit_build_times_t *cbt, circuit_build_times_shuffle_and_store_array(circuit_build_times_t *cbt,

2
src/or/connection_or.c
View File

@ -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, * Requires that both input connections are open; not is_bad_for_new_circs,
* and not impossibly non-canonical. * 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, * <b>a</b>better than <b>b</b> simply because b has no circuits,
* unless b is also relatively old. * unless b is also relatively old.
*/ */

2
src/or/routerparse.h
View File

@ -5,7 +5,7 @@
/* See LICENSE for licensing information */ /* See LICENSE for licensing information */
/** /**
* \file routerpase.h * \file routerparse.h
* \brief Header file for routerparse.c. * \brief Header file for routerparse.c.
**/ **/