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

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

    Code Coverage & Benchmarks

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

    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.

  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: none

    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

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: 2025-08-22 18:12 UTC

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