Similar theme to #16947.
invalid,containsnow appear in Doxygen docssetuprefers to correct argument nameb- Argument references in
code blocks - Lists markdown conformant, uniform line endings
Tested with make docs
cc @JeremyRubin
222 | @@ -226,7 +223,7 @@ class cache 223 | * [0,1) and simply multiply it by the size. Then we just shift the result down by 224 | * 32-bits to get our bucket number. The result has non-uniformity the same as a 225 | * mod, but it is much faster to compute. More about this technique can be found at 226 | - * http://lemire.me/blog/2016/06/27/a-fast-alternative-to-the-modulo-reduction/ 227 | + * http://lemire.me/blog/2016/06/27/a-fast-alternative-to-the-modulo-reduction/.
generally best practice to have a space between url and period (or no period at all)
233 | @@ -237,8 +234,8 @@ class cache 234 | * 32*32->64 multiply, which means the operation is reasonably fast even on a 235 | * typical 32-bit processor. 236 | * 237 | - * @param e the element whose hashes will be returned 238 | - * @returns std::array<uint32_t, 8> of deterministic hashes derived from e 239 | + * @param e The element whose hashes will be returned 240 | + * @returns Deterministic hashes derived from `e`
maybe good to update to say "Deterministic hashes derived from e uniformly mapped onto the range [0, size).
457 | @@ -458,10 +458,10 @@ class cache 458 | * contains returns a bool set true if the element was found. 459 | * 460 | * @param e the element to check 461 | - * @param erase 462 | + * @param erase whether to consider setting the garbage collect flag
not sure if consider is the right verb. It implies theres some other check.
Replaced consider with attempt
maybe
* [@param](/bitcoin-bitcoin/contributor/param/) erase whether to attempt setting the garbage collect flag (element may not exist or flag may already be set)
to make it clear which cases the 'attempt' may fail.
Can't comment on doxygen correctness (obviously -- or I would have written the comments compliant in the first place :p).
Minor nits below
Comments addressed; ready for final review.
ACK 7aad3b68e7e1680870ca70d945eee88f790d6454
ACK 7aad3b68e7e1680870ca70d945eee88f790d6454
Nice cleanup!