[tor-commits] [tor/master] Fix documentation of cache_failure_intro_lookup

[nickm at torproject.org]

commit 98d84587a8e9723f1c964e03de9364508be04b2f
Author: Nick Mathewson <nickm at torproject.org>
Date:   Mon Jul 27 14:22:10 2020 -0400

    Fix documentation of cache_failure_intro_lookup
    
    Closes ticket 17793
---
 src/feature/rend/rendcache.c | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/src/feature/rend/rendcache.c b/src/feature/rend/rendcache.c
index 0890a81d8f..53fec7532f 100644
--- a/src/feature/rend/rendcache.c
+++ b/src/feature/rend/rendcache.c
@@ -340,8 +340,9 @@ rend_cache_failure_purge(void)
 
 /** Lookup the rend failure cache using a relay identity digest in
  * <b>identity</b> which has DIGEST_LEN bytes and service ID <b>service_id</b>
- * which is a null-terminated string. If found, the intro failure is set in
- * <b>intro_entry</b> else it stays untouched. Return 1 iff found else 0. */
+ * which is a null-terminated string. If @a intro_entry is provided, then it
+ * is set to the entry on success, and to NULL on failure.
+ * Return 1 iff found else 0. */
 STATIC int
 cache_failure_intro_lookup(const uint8_t *identity, const char *service_id,
                            rend_cache_failure_intro_t **intro_entry)