diff options
| author | merge-script <fanquake@gmail.com> | 2024-07-23 13:31:55 +0100 |
|---|---|---|
| committer | merge-script <fanquake@gmail.com> | 2024-07-23 13:31:55 +0100 |
| commit | 51ac4792e571623af69a6c3e1031900ea962dce1 (patch) | |
| tree | f0ead169981718cff5f599d6f060242d1e3b6e4c | |
| parent | 910d38b22f575cba9a3325de3f4c5ac667d4a487 (diff) | |
| parent | 6a5e9e40e1dd3d397020703feb9aa0b6f4577c98 (diff) | |
Merge bitcoin/bitcoin#30504: doc: use proper doxygen formatting for CTxMemPool::cs
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
| -rw-r--r-- | src/txmempool.h | 3 |
1 files changed, 0 insertions, 3 deletions
diff --git a/src/txmempool.h b/src/txmempool.h index 52f186f0ff..302addc8f0 100644 --- a/src/txmempool.h +++ b/src/txmempool.h @@ -366,9 +366,7 @@ public: * that are guarded by it. * * @par Consistency guarantees - * * By design, it is guaranteed that: - * * 1. Locking both `cs_main` and `mempool.cs` will give a view of mempool * that is consistent with current chain tip (`ActiveChain()` and * `CoinsTip()`) and is fully populated. Fully populated means that if the @@ -376,7 +374,6 @@ public: * previously active chain, all the missing transactions will have been * re-added to the mempool and should be present if they meet size and * consistency constraints. - * * 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 * locked, and that is fully populated as described above. It is ok for |