Skip to content

Commit e994691

Browse files
fanquakeknst
authored andcommitted
Merge bitcoin#30504: doc: use proper doxygen formatting for CTxMemPool::cs
6a5e9e4 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 6a5e9e4 tdb3: ACK 6a5e9e4 Tree-SHA512: 2c4c9e5fd4bd44754800a9bcfff74df101afc060b84451c45aa098e4ceb05a47f28a36f8473b31222552fad6339b752a148e6b1c7d41c2003f515b3eb4060902
1 parent a3e6378 commit e994691

File tree

1 file changed

+0
-3
lines changed

1 file changed

+0
-3
lines changed

src/txmempool.h

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -494,17 +494,14 @@ class CTxMemPool
494494
* that are guarded by it.
495495
*
496496
* @par Consistency guarantees
497-
*
498497
* By design, it is guaranteed that:
499-
*
500498
* 1. Locking both `cs_main` and `mempool.cs` will give a view of mempool
501499
* that is consistent with current chain tip (`ActiveChain()` and
502500
* `CoinsTip()`) and is fully populated. Fully populated means that if the
503501
* current active chain is missing transactions that were present in a
504502
* previously active chain, all the missing transactions will have been
505503
* re-added to the mempool and should be present if they meet size and
506504
* consistency constraints.
507-
*
508505
* 2. Locking `mempool.cs` without `cs_main` will give a view of a mempool
509506
* consistent with some chain that was active since `cs_main` was last
510507
* locked, and that is fully populated as described above. It is ok for

0 commit comments

Comments
 (0)