diff options
| author | Nick Mathewson <nickm@torproject.org> | 2007-12-19 04:18:28 +0000 |
|---|---|---|
| committer | Nick Mathewson <nickm@torproject.org> | 2007-12-19 04:18:28 +0000 |
| commit | 95fecd6fbc1529205030298245ea838a4dc518d6 (patch) | |
| tree | 2dc302b6caacc104ed8faa3617f89ca8805644c5 /src/or/routerlist.c | |
| parent | 95d500f33fc7e594f4d127e847dd5284e11d62ab (diff) | |
| download | tor-95fecd6fbc1529205030298245ea838a4dc518d6.tar.gz tor-95fecd6fbc1529205030298245ea838a4dc518d6.zip | |
r15560@tombo: nickm | 2007-12-18 23:18:21 -0500
Add a bit of missing documentation.
svn:r12869
Diffstat (limited to 'src/or/routerlist.c')
| -rw-r--r-- | src/or/routerlist.c | 17 |
1 files changed, 9 insertions, 8 deletions
diff --git a/src/or/routerlist.c b/src/or/routerlist.c index 87cf78f61d..e66f8c0b12 100644 --- a/src/or/routerlist.c +++ b/src/or/routerlist.c @@ -2769,8 +2769,8 @@ router_add_to_routerlist(routerinfo_t *router, const char **msg, } /** Insert <b>ei</b> into the routerlist, or free it. Other arguments are - * as for router_add_to_routerlist(). - * DOCDOC Inserted + * as for router_add_to_routerlist(). Return true iff we actually inserted + * it. */ int router_add_extrainfo_to_routerlist(extrainfo_t *ei, const char **msg, @@ -3962,7 +3962,8 @@ static int have_min_dir_info = 0; * enough directory info to build circuits that our old answer can no longer * be trusted. */ static int need_to_update_have_min_dir_info = 1; -/** DOCDOC */ +/** String describing what we're missing before we have enough directory + * info. */ static char dir_info_status[128] = ""; /** Return true iff we have enough networkstatus and router information to @@ -3989,7 +3990,8 @@ router_dir_info_changed(void) need_to_update_have_min_dir_info = 1; } -/** DOCDOC */ +/** Return a string describing what we're missing before we have enough + * directory info. */ const char * get_dir_info_status_string(void) { @@ -4166,14 +4168,13 @@ router_differences_are_cosmetic(routerinfo_t *r1, routerinfo_t *r2) return 1; } -/** Check whether <b>ri</b> is a router compatible with the extrainfo document +/** Check whether <b>ri</b> (a.k.a. sd) is a router compatible with the + * extrainfo document * <b>ei</b>. If no router is compatible with <b>ei</b>, <b>ei</b> should be * dropped. Return 0 for "compatible", return 1 for "reject, and inform * whoever uploaded <b>ei</b>, and return -1 for "reject silently.". If * <b>msg</b> is present, set *<b>msg</b> to a description of the - * incompatibility (if any) - * - * DOCDOC sd. DOCDOC extrainfo_is_bogus. + * incompatibility (if any). **/ int routerinfo_incompatible_with_extrainfo(routerinfo_t *ri, extrainfo_t *ei, |