diff options
| author | Nick Mathewson <nickm@torproject.org> | 2019-11-21 11:56:42 -0500 |
|---|---|---|
| committer | Nick Mathewson <nickm@torproject.org> | 2019-11-21 11:56:42 -0500 |
| commit | cf22841e3bf45a8b73900dd480022f1722d3b557 (patch) | |
| tree | eaf118235275ba66c5a0d9932faed82468205bc9 /src/ext | |
| parent | da15448eb873e0787760bd7c7e47a138a1493d1f (diff) | |
| download | tor-cf22841e3bf45a8b73900dd480022f1722d3b557.tar.gz tor-cf22841e3bf45a8b73900dd480022f1722d3b557.zip | |
ht.h: improve documentation for HT_NEXT_RMV.
Diffstat (limited to 'src/ext')
| -rw-r--r-- | src/ext/ht.h | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/src/ext/ht.h b/src/ext/ht.h index 54e5eb7cba..bb5604131b 100644 --- a/src/ext/ht.h +++ b/src/ext/ht.h @@ -370,7 +370,8 @@ ht_string_hash(const char *s) /* Return the next element in 'head' after 'elm', under the arbitrary \ * order used by HT_START. If there are no more elements, return \ * NULL. If 'elm' is to be removed from the table, you must call \ - * this function for the next value before you remove it. \ + * this function for the next value before you remove it, or use \ + * HT_NEXT_RMV instead. \ */ \ ATTR_UNUSED static inline struct type ** \ name##_HT_NEXT(struct name *head, struct type **elm) \ @@ -392,6 +393,8 @@ ht_string_hash(const char *s) return NULL; \ } \ } \ + /* As HT_NEXT, but also remove the current element 'elm' from the \ + * table. */ \ ATTR_UNUSED static inline struct type ** \ name##_HT_NEXT_RMV(struct name *head, struct type **elm) \ { \ @@ -617,4 +620,3 @@ ht_string_hash(const char *s) */ #endif - |