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.
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.
The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.
For details see: https://corecheck.dev/bitcoin/bitcoin/pulls/33236.
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.
feerate.h
? The wrongful use of the tag is also in coinselection.cpp
and spend.h
. To much churn ?
git grep 'param@'
to find all of them :sweat_smile:
Remove it in feerate.
Fix it in the other places.
ACK 966666de9a6211b8748f43d682490c924e132e58
Housekeeping PR, this PR cleans up or fixes some wrongly used doxygen tags.
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.
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.