aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorglozow <gloriajzhao@gmail.com>2023-12-20 10:48:18 +0000
committerglozow <gloriajzhao@gmail.com>2023-12-20 10:48:41 +0000
commit3a0f54dd2402d74a5ac4304b3ad09014cfb25edf (patch)
tree4faa49c0d8c322107ec2cce6f43ebccaf6f66226
parente3847f7ac4b74893d266770c456d57ed20b9bb8b (diff)
parent19bb65bf255df0f876e37de90fb8c4c6229cdf52 (diff)
downloadbitcoin-3a0f54dd2402d74a5ac4304b3ad09014cfb25edf.tar.xz
Merge bitcoin/bitcoin#29115: [doc]: add doxygen comment describing what `CheckPackageLimits` returns
19bb65bf255df0f876e37de90fb8c4c6229cdf52 [doc]: add doxygen return comment for CheckPackageLimits (ismaelsadeeq) Pull request description: This PR adds a doxygen comment on `CheckPackageLimits` describing what the method returns. Fixes https://github.com/bitcoin/bitcoin/pull/28863#discussion_r1429805433 ACKs for top commit: Sjors: utACK 19bb65bf255df0f876e37de90fb8c4c6229cdf52 Zero-1729: utACK 19bb65bf255df0f876e37de90fb8c4c6229cdf52 Tree-SHA512: ccf1cc00a44d3fff60f28ad6766019a9f61b349729eab3cb02bc76b13c2e55441348a1602d806e60e4b2eabeb1f5d1ddacddf86c0bcdb78b078bb3a863b650c2
-rw-r--r--src/txmempool.h1
1 files changed, 1 insertions, 0 deletions
diff --git a/src/txmempool.h b/src/txmempool.h
index 60640acdb0..9da51756e6 100644
--- a/src/txmempool.h
+++ b/src/txmempool.h
@@ -605,6 +605,7 @@ public:
* to mempool. The transactions need not be direct
* ancestors/descendants of each other.
* @param[in] total_vsize Sum of virtual sizes for all transactions in package.
+ * @returns {} or the error reason if a limit is hit.
*/
util::Result<void> CheckPackageLimits(const Package& package,
int64_t total_vsize) const EXCLUSIVE_LOCKS_REQUIRED(cs);