Update ScanForWalletTransactions result comment

Suggested https://github.com/bitcoin/bitcoin/pull/14711#discussion_r252038666
This commit is contained in:
Russell Yanofsky 2019-01-31 17:48:51 -05:00
parent 95a812b599
commit a8d645c934

View file

@ -1622,10 +1622,11 @@ int64_t CWallet::RescanFromTime(int64_t startTime, const WalletRescanReserver& r
* @param[in] stop_block if not null, the scan will stop at this block instead
* of the chain tip
*
* @return ScanResult indicating success or failure of the scan. SUCCESS if
* scan was successful. FAILURE if a complete rescan was not possible (due to
* pruning or corruption). USER_ABORT if the rescan was aborted before it
* could complete.
* @return ScanResult returning scan information and indicating success or
* failure. Return status will be set to SUCCESS if scan was
* successful. FAILURE if a complete rescan was not possible (due to
* pruning or corruption). USER_ABORT if the rescan was aborted before
* it could complete.
*
* @pre Caller needs to make sure start_block (and the optional stop_block) are on
* the main chain after to the addition of any new keys you want to detect