wallet: Add comment describing the various classes in walletdb.h

This commit is contained in:
Wladimir J. van der Laan 2017-04-21 16:04:26 +02:00
parent 69d2e9ba67
commit 911a4808fb
1 changed files with 15 additions and 0 deletions

View File

@ -17,6 +17,21 @@
#include <utility>
#include <vector>
/**
* Overview of wallet database classes:
*
* - CDBEnv is an environment in which the database exists (has no analog in dbwrapper.h)
* - CWalletDBWrapper represents a wallet database (similar to CDBWrapper in dbwrapper.h)
* - CDB is a low-level database transaction (similar to CDBBatch in dbwrapper.h)
* - CWalletDB is a modifier object for the wallet, and encapsulates a database
* transaction as well as methods to act on the database (no analog in
* dbwrapper.h)
*
* The latter two are named confusingly, in contrast to what the names CDB
* and CWalletDB suggest they are transient transaction objects and don't
* represent the database itself.
*/
static const bool DEFAULT_FLUSHWALLET = true;
class CAccount;