diff options
author | Nick Mathewson <nickm@torproject.org> | 2019-11-07 08:13:31 -0500 |
---|---|---|
committer | Nick Mathewson <nickm@torproject.org> | 2019-11-07 08:13:31 -0500 |
commit | 582cee723a86e44f140a5057152df06659c36e71 (patch) | |
tree | 7ddfa98303125fc428c0cadb0f1a222e3335e101 /src/feature/hs_common/replaycache.h | |
parent | 45698e89edecce71256bc5e2529f9610b0eea50f (diff) | |
download | tor-582cee723a86e44f140a5057152df06659c36e71.tar.gz tor-582cee723a86e44f140a5057152df06659c36e71.zip |
Fix various doxygen comments in feature/hs.
Diffstat (limited to 'src/feature/hs_common/replaycache.h')
-rw-r--r-- | src/feature/hs_common/replaycache.h | 13 |
1 files changed, 9 insertions, 4 deletions
diff --git a/src/feature/hs_common/replaycache.h b/src/feature/hs_common/replaycache.h index 01f5e600c2..812a05d260 100644 --- a/src/feature/hs_common/replaycache.h +++ b/src/feature/hs_common/replaycache.h @@ -14,16 +14,16 @@ typedef struct replaycache_t replaycache_t; #ifdef REPLAYCACHE_PRIVATE struct replaycache_t { - /* Scrub interval */ + /** Scrub interval */ time_t scrub_interval; - /* Last scrubbed */ + /** Last scrubbed */ time_t scrubbed; - /* + /** * Horizon * (don't return true on digests in the cache but older than this) */ time_t horizon; - /* + /** * Digest map: keys are digests, values are times the digest was last seen */ digest256map_t *digests_seen; @@ -34,6 +34,11 @@ struct replaycache_t { /* replaycache_t free/new */ void replaycache_free_(replaycache_t *r); +/** + * @copydoc replaycache_free_ + * + * Additionally, set the pointer <b>r</b> to NULL. + **/ #define replaycache_free(r) \ FREE_AND_NULL(replaycache_t, replaycache_free_, (r)) replaycache_t * replaycache_new(time_t horizon, time_t interval); |