diff options
| author | teor (Tim Wilson-Brown) <teor2345@gmail.com> | 2016-07-08 12:30:20 +1000 |
|---|---|---|
| committer | teor <teor2345@gmail.com> | 2016-08-24 10:32:22 +1000 |
| commit | cad9046632aa168eabda1694775393b38922a03e (patch) | |
| tree | 9da16ae95277d7d5c1a1eb4004382e2e85bde1f8 /src/or/circuitlist.c | |
| parent | febd4ab0e5304a129fb2757949b9a452e7cce162 (diff) | |
| download | tor-cad9046632aa168eabda1694775393b38922a03e.tar.gz tor-cad9046632aa168eabda1694775393b38922a03e.zip | |
Improve comments in circuit_get_cpath_*
Diffstat (limited to 'src/or/circuitlist.c')
| -rw-r--r-- | src/or/circuitlist.c | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/src/or/circuitlist.c b/src/or/circuitlist.c index d2ba7d4781..0d56a7ee20 100644 --- a/src/or/circuitlist.c +++ b/src/or/circuitlist.c @@ -1613,7 +1613,8 @@ circuit_find_to_cannibalize(uint8_t purpose, extend_info_t *info, return best; } -/** Return the number of hops in circuit's path. */ +/** Return the number of hops in circuit's path. If circ has no entries, + * or is NULL, returns 0. */ int circuit_get_cpath_len(origin_circuit_t *circ) { @@ -1629,7 +1630,8 @@ circuit_get_cpath_len(origin_circuit_t *circ) } /** Return the <b>hopnum</b>th hop in <b>circ</b>->cpath, or NULL if there - * aren't that many hops in the list. */ + * aren't that many hops in the list. <b>hopnum</b> starts at 1. + * Returns NULL if <b>hopnum</b> is 0 or negative. */ crypt_path_t * circuit_get_cpath_hop(origin_circuit_t *circ, int hopnum) { |