sikkienl/dash
1
0
Fork 0
mirror of https://github.com/dashpay/dash.git synced 2024-12-25 20:12:57 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge bitcoin/bitcoin#30504: doc: use proper doxygen formatting for CTxMemPool::cs

Browse Source 
6a5e9e40e1dd3d397020703feb9aa0b6f4577c98 doc: use proper doxygen formatting for CTxMemPool::cs (Vasil Dimov)

Pull request description:

  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.
  ```

ACKs for top commit:
  maflcko:
    review ACK 6a5e9e40e1dd3d397020703feb9aa0b6f4577c98
  tdb3:
    ACK 6a5e9e40e1dd3d397020703feb9aa0b6f4577c98

Tree-SHA512: 2c4c9e5fd4bd44754800a9bcfff74df101afc060b84451c45aa098e4ceb05a47f28a36f8473b31222552fad6339b752a148e6b1c7d41c2003f515b3eb4060902
This commit is contained in:
merge-script 2024-07-23 13:31:55 +01:00 committed by Konstantin Akimov
parent a3e6378108
commit e994691e2d
No known key found for this signature in database
GPG Key ID: 2176C4A5D01EA524
1 changed files with 0 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/txmempool.h
View File

@ -494,9 +494,7 @@ public:
* that are guarded by it. * that are guarded by it.
* *
* @par Consistency guarantees * @par Consistency guarantees
*
* By design, it is guaranteed that: * By design, it is guaranteed that:
*
* 1. Locking both `cs_main` and `mempool.cs` will give a view of mempool * 1. Locking both `cs_main` and `mempool.cs` will give a view of mempool
* that is consistent with current chain tip (`ActiveChain()` and * that is consistent with current chain tip (`ActiveChain()` and
* `CoinsTip()`) and is fully populated. Fully populated means that if the * `CoinsTip()`) and is fully populated. Fully populated means that if the
@ -504,7 +502,6 @@ public:
* previously active chain, all the missing transactions will have been * previously active chain, all the missing transactions will have been
* re-added to the mempool and should be present if they meet size and * re-added to the mempool and should be present if they meet size and
* consistency constraints. * consistency constraints.
*
* 2. Locking `mempool.cs` without `cs_main` will give a view of a mempool * 2. Locking `mempool.cs` without `cs_main` will give a view of a mempool
* consistent with some chain that was active since `cs_main` was last * consistent with some chain that was active since `cs_main` was last
* locked, and that is fully populated as described above. It is ok for * locked, and that is fully populated as described above. It is ok for