refactor/doc: Add blockman param to GetTransaction doc comment #33683

1. 
   musaHaruna commented at 9:17 PM on October 22, 2025: contributor

   Follow-up to #27125

   This PR addresses a minor documentation and style nit mentioned during review:

   • Adds the missing @param[in] blockman line to the GetTransaction() doc comment.
   • Moves the output parameter hashBlock to the end of both the function declaration and definition, as suggested in the comment.
2. DrahtBot added the label Docs on Oct 22, 2025
3. 
   DrahtBot commented at 9:17 PM on October 22, 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/33683.

   <!--021abf342d371248e50ceaed478a90ca-->

   Reviews

   See the guideline for information on the review process.

   Type	Reviewers
   ACK	l0rinc, maflcko, kevkevinpal

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

   <!--5faf32d7da4f0f540f40219e4f7537a3-->

4. in src/node/transaction.h:64 in c5a0abb270 outdated

     59 | @@ -60,10 +60,11 @@ static const CAmount DEFAULT_MAX_BURN_AMOUNT{0};
     60 |   * @param[in]  block_index     The block to read from disk, or nullptr
     61 |   * @param[in]  mempool         If provided, check mempool for tx
     62 |   * @param[in]  hash            The txid
     63 | + * @param[in]  blockman        Used to access and read blocks from disk
     64 |   * @param[out] hashBlock       The block hash, if the tx was found via -txindex or block_index
   

   ---

   ---

   

   kevkevinpal commented at 12:02 AM on October 23, 2025:

   Just add the comment instead of changing the order of the params.

    * [@param](/bitcoin-bitcoin/contributor/param/)[out] hashBlock       The block hash, if the tx was found via -txindex or block_index
    * [@param](/bitcoin-bitcoin/contributor/param/)[in]  blockman        Used to access and read blocks from disk
   

   ---

   

   musaHaruna commented at 5:58 AM on October 23, 2025:

   I followed the coding style from the documentation coding-style-doxygen-compatible-comments. Maybe I might be overlooking something...

   ---

   

   kevkevinpal commented at 8:31 PM on October 23, 2025:

   yea I agree that this fits and looks better with the out as the last param. Maybe you can change the title and commit message to be refactor/doc since code refactoring is being done.

   But that is a minor nit

   ---

   

   musaHaruna commented at 4:44 PM on October 24, 2025:

   Done. Thanks for the suggestion

5. 
   kevkevinpal commented at 12:06 AM on October 23, 2025: contributor

   Since this is just a doc change and not a refactor I'd just move the comment down a line and only make a change there.

6. 
   maflcko commented at 6:44 AM on October 23, 2025: member

   lgtm ACK c5a0abb270f37ec391ce6e3ea5219584816adc54

7. 
   musaHaruna commented at 7:41 AM on October 23, 2025: contributor

   Friendly ping @TheCharlatan and @mzumsande

8. musaHaruna renamed this:
   doc: Add blockman param to GetTransaction doc comment
   refactor/doc: Add blockman param to GetTransaction doc comment
   on Oct 24, 2025
9. refactor/doc: Add blockman param to `GetTransaction` doc comment and reorder out param 1a1f46c228
10. musaHaruna force-pushed on Oct 24, 2025
11. 
    l0rinc commented at 4:53 PM on October 24, 2025: contributor

    Recreated the change locally, matches the version in the PR.

    ACK 1a1f46c2285994908df9c11991c1f363c9733087

12. DrahtBot requested review from maflcko on Oct 24, 2025
13. 
    maflcko commented at 7:40 AM on October 25, 2025: member

    re-lgtm-ut-cr-rfm-ACK 1a1f46c2285994908df9c11991c1f363c9733087

14. 
    kevkevinpal commented at 10:17 PM on October 28, 2025: contributor

    reACK 1a1f46c

15. glozow merged this on Oct 31, 2025
16. glozow closed this on Oct 31, 2025

    ---

Contributors

musaHarunaDrahtBotkevkevinpalmaflckol0rinc

Review Requested
maflcko