Prompted by #36594 (review).
doc: fix docs and enable `-Wdocumentation-unknown-command` #36704
pull fanquake wants to merge 3 commits into bitcoin:master from fanquake:doc_param_direction_fixes changing 13 files +36 −30-
fanquake commented at 11:48 AM on October 30, 2026: member
- DrahtBot added the label Docs on Oct 30, 2026
-
DrahtBot commented at 11:48 AM on October 30, 2026: contributor
<!--e57a25ab6845829454e8d69fc972939a-->
The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.
<!--006a51241073e994b41acfe9ec718e94-->
External sites
- Code coverage & benchmarks: https://corecheck.dev/bitcoin/bitcoin/pulls/36704
- Ralph review <img src=https://review.fish.foo/assets/bitcoin/bitcoin/36704.png alt="Ralph review status"> https://git.fish.foo/bitcoin/bitcoin/pulls/36704#author-ralph
<!--021abf342d371248e50ceaed478a90ca-->
Reviews
See the guideline and AI policy for information on the review process. A summary of reviews will appear here.
<!--5faf32d7da4f0f540f40219e4f7537a3-->
-
doc: fix incorrect @param annotations e39993193c
-
c182b8005e
doc: use doxygen comments for blocks containing @param
Plain /* comments are ignored by Doxygen and by clang's -Wdocumentation, so mistakes in them go unnoticed. Also wrap the CoinGrinder ASCII trees in @verbatim so Doxygen keeps their layout.
-
2c8c91c5a0
build: enable -Wdocumentation-unknown-command
Catches misspelled doxygen commands such as '@peer[in]' (for '@param[in]'), which -Wdocumentation alone does not report. i.e ```bash ../src/net_processing.cpp:717:8: warning: unknown command tag name [-Wdocumentation-unknown-command] 717 | * @peer[in] peer The peer whose orphan transactions we will reconsider. Generally only | ^~~~~ 1 warning generated. ``` - fanquake force-pushed on Oct 30, 2026
- DrahtBot added the label CI failed on Oct 30, 2026
- DrahtBot removed the label CI failed on Oct 30, 2026
Labels