doc: use proper doxygen formatting for CTxMemPool::cs #30504

pull vasild wants to merge 1 commits into bitcoin:master from vasild:doc_doxygen_par changing 1 files +0 −3
  1. vasild commented at 10:28 am on July 23, 2024: contributor

    Having @par title followed by an empty line renders improperly in Doxygen - it results in a paragraph with a title but without a body.

    https://www.doxygen.nl/manual/commands.html#cmdpar

    This also results in a compiler warning (or error) with Clang 19:

    0./txmempool.h:368:34: error: empty paragraph passed to '@par' command [-Werror,-Wdocumentation]
    1  368 |      * [@par](/bitcoin-bitcoin/contributor/par/) Consistency guarantees
    2      |        ~~~~~~~~~~~~~~~~~~~~~~~~~~^
    31 error generated.
    
  2. doc: use proper doxygen formatting for CTxMemPool::cs
    Having `@par title` followed by an empty line renders improperly in
    Doxygen - it results in a paragraph with a title but without a body.
    
    https://www.doxygen.nl/manual/commands.html#cmdpar
    
    This also results in a compiler warning (or error) with Clang 19:
    
    ```
    ./txmempool.h:368:34: error: empty paragraph passed to '@par' command [-Werror,-Wdocumentation]
      368 |      * @par Consistency guarantees
          |        ~~~~~~~~~~~~~~~~~~~~~~~~~~^
    1 error generated.
    ```
    6a5e9e40e1
  3. DrahtBot commented at 10:28 am on July 23, 2024: contributor

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

    Code Coverage

    For detailed information about the code coverage, see the test coverage report.

    Reviews

    See the guideline for information on the review process.

    Type Reviewers
    ACK maflcko, tdb3

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

  4. DrahtBot added the label Docs on Jul 23, 2024
  5. maflcko commented at 10:43 am on July 23, 2024: member
    review ACK 6a5e9e40e1dd3d397020703feb9aa0b6f4577c98
  6. tdb3 approved
  7. tdb3 commented at 10:49 am on July 23, 2024: contributor

    ACK 6a5e9e40e1dd3d397020703feb9aa0b6f4577c98 Looks to be rendered correctly now:

    image

  8. fanquake merged this on Jul 23, 2024
  9. fanquake closed this on Jul 23, 2024

  10. vasild deleted the branch on Jul 23, 2024

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: 2024-09-08 01:12 UTC

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