From cb0d208f6ba8c272c0963fe2098e40624c6ce91a Mon Sep 17 00:00:00 2001 From: Simon Date: Thu, 13 Oct 2016 16:54:07 -0700 Subject: [PATCH] Document CWallet::GetFilteredNotes and fix return type which should be void. --- src/wallet/wallet.cpp | 6 +++++- src/wallet/wallet.h | 4 ++-- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/src/wallet/wallet.cpp b/src/wallet/wallet.cpp index 495572bb0..42bebf224 100644 --- a/src/wallet/wallet.cpp +++ b/src/wallet/wallet.cpp @@ -3314,7 +3314,11 @@ bool CMerkleTx::AcceptToMemoryPool(bool fLimitFree, bool fRejectAbsurdFee) return ::AcceptToMemoryPool(mempool, state, *this, fLimitFree, NULL, fRejectAbsurdFee); } -bool CWallet::GetFilteredNotes(std::vector & outEntries, std::string address, int minDepth, bool ignoreSpent) +/** + * Find notes in the wallet filtered by payment address, min depth and ability to spend. + * These notes are decrypted and added to the output parameter vector, outEntries. + */ +void CWallet::GetFilteredNotes(std::vector & outEntries, std::string address, int minDepth, bool ignoreSpent) { bool fFilterAddress = false; libzcash::PaymentAddress filterPaymentAddress; diff --git a/src/wallet/wallet.h b/src/wallet/wallet.h index c3f1fd63f..3ce551f2f 100644 --- a/src/wallet/wallet.h +++ b/src/wallet/wallet.h @@ -241,7 +241,7 @@ public: typedef std::map mapNoteData_t; - +/** Decrypted note and its location in a transaction. */ struct CNotePlaintextEntry { JSOutPoint jsop; @@ -911,7 +911,7 @@ public: void SetBroadcastTransactions(bool broadcast) { fBroadcastTransactions = broadcast; } /* Find notes filtered by payment address, min depth, ability to spend */ - bool GetFilteredNotes(std::vector & outEntries, std::string address, int minDepth=1, bool ignoreSpent=true); + void GetFilteredNotes(std::vector & outEntries, std::string address, int minDepth=1, bool ignoreSpent=true); };