doc: Doxygen-friendly CuckooCache comments #16986

pull ch4ot1c wants to merge 1 commits into bitcoin:master from ch4ot1c:doc/cuckoocache changing 2 files +55 −54
  1. ch4ot1c commented at 12:05 AM on September 30, 2019: contributor

    Similar theme to #16947.

    • invalid, contains now appear in Doxygen docs
    • setup refers to correct argument name b
    • Argument references in code blocks
    • Lists markdown conformant, uniform line endings

    Tested with make docs

  2. fanquake added the label Docs on Sep 30, 2019
  3. fanquake commented at 12:06 AM on September 30, 2019: member
  4. in src/cuckoocache.h:226 in f792f984ab outdated
     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/.
    


    JeremyRubin commented at 6:22 PM on October 4, 2019:

    generally best practice to have a space between url and period (or no period at all)

  5. in src/cuckoocache.h:238 in f792f984ab outdated
     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`
    


    JeremyRubin commented at 6:24 PM on October 4, 2019:

    maybe good to update to say "Deterministic hashes derived from e uniformly mapped onto the range [0, size).

  6. in src/cuckoocache.h:461 in f792f984ab outdated
     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
    


    JeremyRubin commented at 6:27 PM on October 4, 2019:

    not sure if consider is the right verb. It implies theres some other check.


    ch4ot1c commented at 7:49 PM on October 10, 2019:

    Replaced consider with attempt


    JeremyRubin commented at 8:40 PM on October 10, 2019:

    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.

  7. JeremyRubin commented at 6:27 PM on October 4, 2019: contributor

    Can't comment on doxygen correctness (obviously -- or I would have written the comments compliant in the first place :p).

    Minor nits below

  8. fanquake added the label Waiting for author on Oct 4, 2019
  9. ch4ot1c force-pushed on Oct 10, 2019
  10. doc: Doxygen-friendly CuckooCache comments 7aad3b68e7
  11. ch4ot1c force-pushed on Oct 10, 2019
  12. ch4ot1c commented at 2:32 AM on October 15, 2019: contributor

    Comments addressed; ready for final review.

  13. fanquake removed the label Waiting for author on Oct 15, 2019
  14. laanwj commented at 10:28 AM on October 26, 2019: member

    ACK 7aad3b68e7e1680870ca70d945eee88f790d6454

  15. practicalswift commented at 10:03 PM on October 27, 2019: contributor

    ACK 7aad3b68e7e1680870ca70d945eee88f790d6454

    Nice cleanup!

  16. fanquake referenced this in commit 1ab6c1267e on Oct 28, 2019
  17. fanquake merged this on Oct 28, 2019
  18. fanquake closed this on Oct 28, 2019

  19. sidhujag referenced this in commit c5dbe3670a on Oct 28, 2019
  20. MarkLTZ referenced this in commit 8823f65197 on Apr 7, 2020
  21. MarkLTZ referenced this in commit 0a1571d657 on Apr 7, 2020
  22. sidhujag referenced this in commit ee8836b266 on Nov 10, 2020
  23. zkbot referenced this in commit bb6e5fad4c on Apr 20, 2021
  24. PastaPastaPasta referenced this in commit 3de88f9b7a on Jun 27, 2021
  25. PastaPastaPasta referenced this in commit 31232762d5 on Jun 28, 2021
  26. PastaPastaPasta referenced this in commit cb72f16e22 on Jun 29, 2021
  27. PastaPastaPasta referenced this in commit 1a13be6dc0 on Jul 1, 2021
  28. PastaPastaPasta referenced this in commit b81f61591b on Jul 1, 2021
  29. PastaPastaPasta referenced this in commit 5b34ff455b on Jul 12, 2021
  30. PastaPastaPasta referenced this in commit 5a334e805f on Jul 13, 2021
  31. PastaPastaPasta referenced this in commit 9b8250c7c6 on Jul 13, 2021
  32. MarcoFalke locked this on Dec 16, 2021

github-metadata-mirror

This is a metadata mirror of the GitHub repository bitcoin/bitcoin. This site is not affiliated with GitHub. Content is generated from a GitHub metadata backup.
generated: 2026-04-14 21:14 UTC

This site is hosted by @0xB10C
More mirrored repositories can be found on mirror.b10c.me