Skip to content

Commit

Permalink
doc: use proper doxygen formatting for CTxMemPool::cs
Browse files Browse the repository at this point in the history
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.
```
  • Loading branch information
vasild committed Jul 23, 2024
1 parent 8754d05 commit 6a5e9e4
Showing 1 changed file with 0 additions and 3 deletions.
3 changes: 0 additions & 3 deletions src/txmempool.h
Original file line number Diff line number Diff line change
Expand Up @@ -366,17 +366,14 @@ class CTxMemPool
* 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
* current active chain is missing transactions that were present in a
* 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
Expand Down

0 comments on commit 6a5e9e4

Please sign in to comment.