highperfocused/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-06-26 17:02:00 +02:00
Code Issues Packages Projects Releases Wiki Activity

doc: use proper doxygen formatting for CTxMemPool::cs

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

Github-Pull: #30504
Rebased-From: 6a5e9e40e1dd3d397020703feb9aa0b6f4577c98
This commit is contained in:
Vasil Dimov 2024-07-23 12:21:41 +02:00 committed by fanquake
parent 882e0d730d
commit c838ce514f
No known key found for this signature in database
GPG Key ID: 2EEB9F5CC09526C1
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

@ -363,9 +363,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
@ -373,7 +371,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