diff options
| author | Nick Mathewson <nickm@torproject.org> | 2007-01-22 07:51:06 +0000 |
|---|---|---|
| committer | Nick Mathewson <nickm@torproject.org> | 2007-01-22 07:51:06 +0000 |
| commit | 84790d059fc08bc086104a8ee0486690c0d0adba (patch) | |
| tree | 751dbcb16afc5c291f735c05fc5a70a496cfba51 /src/or/router.c | |
| parent | d634e5b9af38541fed4b684a9ed1ba8ed35e4326 (diff) | |
| download | tor-84790d059fc08bc086104a8ee0486690c0d0adba.tar.gz tor-84790d059fc08bc086104a8ee0486690c0d0adba.zip | |
r9715@catbus: nickm | 2007-01-22 02:51:04 -0500
Document a few undocumented functions and arguments.
svn:r9385
Diffstat (limited to 'src/or/router.c')
| -rw-r--r-- | src/or/router.c | 13 |
1 files changed, 10 insertions, 3 deletions
diff --git a/src/or/router.c b/src/or/router.c index 35f1225834..2a36749698 100644 --- a/src/or/router.c +++ b/src/or/router.c @@ -381,7 +381,7 @@ static int can_reach_or_port = 0; /** Whether we can reach our DirPort from the outside. */ static int can_reach_dir_port = 0; -/** DOCDOC */ +/** Forget what we have learned about our reachability status. */ void router_reset_reachability(void) { @@ -769,7 +769,8 @@ router_get_my_descriptor(void) return body; } -/*DOCDOC*/ +/** A list of nicknames that we've warned about including in our family + * declaration verbatim rather than as digests. */ static smartlist_t *warned_nonexistent_family = NULL; static int router_guess_address_from_dir_headers(uint32_t *guess); @@ -1315,7 +1316,13 @@ is_legal_hexdigest(const char *s) strspn(s,HEX_CHARACTERS)==HEX_DIGEST_LEN); } -/** DOCDOC buf must have MAX_VERBOSE_NICKNAME_LEN+1 bytes. */ +/** Set <b>buf</b> (which must have MAX_VERBOSE_NICKNAME_LEN+1 bytes) to the + * verbose representation of the identity of <b>router</b>. The format is: + * A dollar sign. + * The upper-case hexadecimal encoding of the SHA1 hash of router's identity. + * A "=" if the router is named; a "~" if it is not. + * The router's nickname. + **/ void router_get_verbose_nickname(char *buf, routerinfo_t *router) { |