Document CWalletTx::FindMyNotes

Part of #1447

diff --git a/src/wallet/wallet.cpp b/src/wallet/wallet.cpp
index 495572bb095e9aa12e4a91dbbedef4dbedaa71fb..3a102546abcba545c4d0e2ceba4ff8f644bfd97b 100644 (file)
--- a/src/wallet/wallet.cpp
+++ b/src/wallet/wallet.cpp
@@ -1117,6 +1117,14 @@ void CWallet::EraseFromWallet(const uint256 &hash)
 }
 
 
+/**
+ * Finds all output notes in the given transaction that have been sent to
+ * PaymentAddresses in this wallet.
+ *
+ * It should never be necessary to call this method with a CWalletTx, because
+ * the result of FindMyNotes (for the addresses available at the time) will
+ * already have been cached in CWalletTx.mapNoteData.
+ */
 mapNoteData_t CWallet::FindMyNotes(const CTransaction& tx) const
 {
     LOCK(cs_SpendingKeyStore);