doc: Remove wrong and redundant doxygen tag #33236

pull maflcko wants to merge 1 commits into bitcoin:master from maflcko:2508-doc-doxygen changing 3 files +22 −25
  1. maflcko commented at 11:54 AM on August 21, 2025: member

    param@[in] is not a valid doxygen tag. Also, no other function in this file uses the annotations, and they are redundant with the line above, so just remove them in feerate to fix all issues.

    In other places, fix them.

  2. DrahtBot added the label Docs on Aug 21, 2025
  3. DrahtBot commented at 11:54 AM on August 21, 2025: contributor

    <!--e57a25ab6845829454e8d69fc972939a-->

    The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

    <!--006a51241073e994b41acfe9ec718e94-->

    Code Coverage & Benchmarks

    For details see: https://corecheck.dev/bitcoin/bitcoin/pulls/33236.

    <!--021abf342d371248e50ceaed478a90ca-->

    Reviews

    See the guideline for information on the review process.

    Type Reviewers
    ACK janb84, pablomartin4btc, cedwies, w0xlt

    If your review is incorrectly listed, please react with 👎 to this comment and the bot will ignore it on the next update.

    <!--5faf32d7da4f0f540f40219e4f7537a3-->

  4. janb84 commented at 12:50 PM on August 21, 2025: contributor

    Is there a reason why this change is limited to only feerate.h ? The wrongful use of the tag is also in coinselection.cpp and spend.h. To much churn ?

  5. maflcko commented at 1:10 PM on August 21, 2025: member

    Thx, done. Good catch actually calling git grep 'param@' to find all of them :sweat_smile:

  6. maflcko force-pushed on Aug 21, 2025
  7. maflcko force-pushed on Aug 21, 2025
  8. doc: Remove wrong and redundant doxygen tag
    Remove it in feerate.
    
    Fix it in the other places.
    966666de9a
  9. maflcko force-pushed on Aug 21, 2025
  10. janb84 commented at 1:23 PM on August 21, 2025: contributor

    ACK 966666de9a6211b8748f43d682490c924e132e58

    Housekeeping PR, this PR cleans up or fixes some wrongly used doxygen tags.

  11. pablomartin4btc approved
  12. pablomartin4btc commented at 3:19 PM on August 21, 2025: member

    ACK 966666de9a6211b8748f43d682490c924e132e58

    Checked that there aren't more pending corrections left for @param (and for others by looking for "@[").

    The corrections match the specification in the doxygen-compatible comments section on the dev-notes and in doxygen itself on the param command.

  13. cedwies commented at 6:18 PM on August 21, 2025: contributor

    ACK 966666d

    Checked for other invalid tags with git grep -n -E "@\[[^]]+\]" -- src | grep -v -E "@param\[(in|out|in,out)\]". In feerate.h, removal of the param lines makes sense: no other functions in that file use @param, and the info was redundant with the signature. In coinselection.cpp and spend.h, (corrected tags) (@param[in], @param[out]) improve clarity where functions have many parameters with mixed roles.

  14. fanquake merged this on Aug 22, 2025
  15. fanquake closed this on Aug 22, 2025

  16. maflcko deleted the branch on Aug 22, 2025
  17. fanquake referenced this in commit 6448ebb5a7 on Aug 29, 2025
  18. glozow referenced this in commit fd784f2774 on Sep 3, 2025
  19. ajtowns referenced this in commit dae54a130f on Sep 4, 2025
  20. alexanderwiederin referenced this in commit 49e068b15b on Sep 16, 2025
  21. alexanderwiederin referenced this in commit 4b0c2f2a8f on Sep 17, 2025
  22. alexanderwiederin referenced this in commit 2edb618ffe on Sep 17, 2025
  23. fanquake referenced this in commit 7c59f03edc on Sep 17, 2025
  24. fanquake commented at 2:18 PM on September 17, 2025: member

    Backported to 28.x in #33415.

  25. stringintech referenced this in commit fb8510ba20 on Sep 17, 2025
  26. fanquake referenced this in commit 4598dfcfde on Sep 24, 2025
  27. achow101 referenced this in commit a0b5730f85 on Sep 25, 2025
  28. bug-castercv502 referenced this in commit 9f5d12d027 on Sep 28, 2025
  29. yuvicc referenced this in commit d89c6d0002 on Sep 28, 2025
  30. stickies-v referenced this in commit a785fe6759 on Nov 5, 2025
  31. morozow referenced this in commit 170c27980d on May 8, 2026
  32. morozow referenced this in commit 00232b7453 on May 8, 2026
  33. morozow referenced this in commit 555a8fe7a0 on May 8, 2026
  34. morozow referenced this in commit 76c99ef843 on May 8, 2026
  35. Kino1994 referenced this in commit 86d8ea8781 on Jun 28, 2026
  36. BigcoinBGC referenced this in commit 1e55434268 on Jun 30, 2026
  37. Kino1994 referenced this in commit fb1883a7e6 on Aug 19, 2026
  38. bitcoin locked this on Sep 17, 2026

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-09-21 00:52 UTC

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