aboutsummaryrefslogtreecommitdiff
path: root/src/or/routerlist.h
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2012-06-05 00:17:54 -0400
committerNick Mathewson <nickm@torproject.org>2012-06-05 00:17:54 -0400
commit913067f788d84d748d9377bb5563b2a8f88dc483 (patch)
treec0407004c0a59d852040abfa67ba4fe94321af37 /src/or/routerlist.h
parent064e7c19c66a6e8a65e13508c57f3d7c89060112 (diff)
downloadtor-913067f788d84d748d9377bb5563b2a8f88dc483.tar.gz
tor-913067f788d84d748d9377bb5563b2a8f88dc483.zip
Resolve about 24 DOCDOCs
Diffstat (limited to 'src/or/routerlist.h')
-rw-r--r--src/or/routerlist.h11
1 files changed, 7 insertions, 4 deletions
diff --git a/src/or/routerlist.h b/src/or/routerlist.h
index 3aee0f8bbe..8dcc6eb026 100644
--- a/src/or/routerlist.h
+++ b/src/or/routerlist.h
@@ -85,14 +85,16 @@ void router_set_status(const char *digest, int up);
static int WRA_WAS_ADDED(was_router_added_t s);
static int WRA_WAS_OUTDATED(was_router_added_t s);
static int WRA_WAS_REJECTED(was_router_added_t s);
-/** Return true iff the descriptor was added. It might still be necessary to
- * check whether the descriptor generator should be notified.
+/** Return true iff the outcome code in <b>s</b> indicates that the descriptor
+ * was added. It might still be necessary to check whether the descriptor
+ * generator should be notified.
*/
static INLINE int
WRA_WAS_ADDED(was_router_added_t s) {
return s == ROUTER_ADDED_SUCCESSFULLY || s == ROUTER_ADDED_NOTIFY_GENERATOR;
}
-/** Return true iff the descriptor was not added because it was either:
+/** Return true iff the outcome code in <b>s</b> indicates that the descriptor
+ * was not added because it was either:
* - not in the consensus
* - neither in the consensus nor in any networkstatus document
* - it was outdated.
@@ -103,7 +105,8 @@ static INLINE int WRA_WAS_OUTDATED(was_router_added_t s)
s == ROUTER_NOT_IN_CONSENSUS ||
s == ROUTER_NOT_IN_CONSENSUS_OR_NETWORKSTATUS);
}
-/* DOCDOC WRA_WAS_REJECTED */
+/** Return true iff the outcome code in <b>s</b> indicates that the descriptor
+ * was flat-out rejected. */
static INLINE int WRA_WAS_REJECTED(was_router_added_t s)
{
return (s == ROUTER_AUTHDIR_REJECTS);