Trivial: fixup a few doxygen comments
These were not declared properly, so their results are not properly processed. E.g.: https://dev.visucore.com/bitcoin/doxygen/rpcdump_8cpp.html#a994c8748aaa60fbb78009ff8a0638dea https://dev.visucore.com/bitcoin/doxygen/coins_8cpp.html#aa03af24ef3570144b045f4fca7a0d603 https://dev.visucore.com/bitcoin/doxygen/wallet_2wallet_8cpp.html#a5c2a7725ff8796f03471f844ecded3d9
This commit is contained in:
4 files changed
+24
-24
No files matched your search
+6
-6
@@ -298,17 +298,17 @@ private:
|
|||||||
};
|
};
|
||||||
|
|
||||||
//! Utility function to add all of a transaction's outputs to a cache.
|
//! Utility function to add all of a transaction's outputs to a cache.
|
||||||
// When check is false, this assumes that overwrites are only possible for coinbase transactions.
|
//! When check is false, this assumes that overwrites are only possible for coinbase transactions.
|
||||||
// When check is true, the underlying view may be queried to determine whether an addition is
|
//! When check is true, the underlying view may be queried to determine whether an addition is
|
||||||
// an overwrite.
|
//! an overwrite.
|
||||||
// TODO: pass in a boolean to limit these possible overwrites to known
|
// TODO: pass in a boolean to limit these possible overwrites to known
|
||||||
// (pre-BIP34) cases.
|
// (pre-BIP34) cases.
|
||||||
void AddCoins(CCoinsViewCache& cache, const CTransaction& tx, int nHeight, bool check = false);
|
void AddCoins(CCoinsViewCache& cache, const CTransaction& tx, int nHeight, bool check = false);
|
||||||
|
|
||||||
//! Utility function to find any unspent output with a given txid.
|
//! Utility function to find any unspent output with a given txid.
|
||||||
// This function can be quite expensive because in the event of a transaction
|
//! This function can be quite expensive because in the event of a transaction
|
||||||
// which is not found in the cache, it can cause up to MAX_OUTPUTS_PER_BLOCK
|
//! which is not found in the cache, it can cause up to MAX_OUTPUTS_PER_BLOCK
|
||||||
// lookups to database, so it should be used with care.
|
//! lookups to database, so it should be used with care.
|
||||||
const Coin& AccessByTxid(const CCoinsViewCache& cache, const uint256& txid);
|
const Coin& AccessByTxid(const CCoinsViewCache& cache, const uint256& txid);
|
||||||
|
|
||||||
#endif // BITCOIN_COINS_H
|
#endif // BITCOIN_COINS_H
|
||||||
@@ -273,17 +273,17 @@ public:
|
|||||||
void SetMaxOutboundTimeframe(uint64_t timeframe);
|
void SetMaxOutboundTimeframe(uint64_t timeframe);
|
||||||
uint64_t GetMaxOutboundTimeframe();
|
uint64_t GetMaxOutboundTimeframe();
|
||||||
|
|
||||||
//!check if the outbound target is reached
|
//! check if the outbound target is reached
|
||||||
// if param historicalBlockServingLimit is set true, the function will
|
//! if param historicalBlockServingLimit is set true, the function will
|
||||||
// response true if the limit for serving historical blocks has been reached
|
//! response true if the limit for serving historical blocks has been reached
|
||||||
bool OutboundTargetReached(bool historicalBlockServingLimit);
|
bool OutboundTargetReached(bool historicalBlockServingLimit);
|
||||||
|
|
||||||
//!response the bytes left in the current max outbound cycle
|
//! response the bytes left in the current max outbound cycle
|
||||||
// in case of no limit, it will always response 0
|
//! in case of no limit, it will always response 0
|
||||||
uint64_t GetOutboundTargetBytesLeft();
|
uint64_t GetOutboundTargetBytesLeft();
|
||||||
|
|
||||||
//!response the time in second left in the current max outbound cycle
|
//! response the time in second left in the current max outbound cycle
|
||||||
// in case of no limit, it will always response 0
|
//! in case of no limit, it will always response 0
|
||||||
uint64_t GetMaxOutboundTimeLeftInCycle();
|
uint64_t GetMaxOutboundTimeLeftInCycle();
|
||||||
|
|
||||||
uint64_t GetTotalBytesRecv();
|
uint64_t GetTotalBytesRecv();
|
||||||
|
|||||||
@@ -849,9 +849,9 @@ struct ImportData
|
|||||||
|
|
||||||
enum class ScriptContext
|
enum class ScriptContext
|
||||||
{
|
{
|
||||||
TOP, //! Top-level scriptPubKey
|
TOP, //!< Top-level scriptPubKey
|
||||||
P2SH, //! P2SH redeemScript
|
P2SH, //!< P2SH redeemScript
|
||||||
WITNESS_V0, //! P2WSH witnessScript
|
WITNESS_V0, //!< P2WSH witnessScript
|
||||||
};
|
};
|
||||||
|
|
||||||
// Analyse the provided scriptPubKey, determining which keys and which redeem scripts from the ImportData struct are needed to spend it, and mark them as used.
|
// Analyse the provided scriptPubKey, determining which keys and which redeem scripts from the ImportData struct are needed to spend it, and mark them as used.
|
||||||
|
|||||||
+8
-8
@@ -35,8 +35,8 @@
|
|||||||
#include <vector>
|
#include <vector>
|
||||||
|
|
||||||
//! Responsible for reading and validating the -wallet arguments and verifying the wallet database.
|
//! Responsible for reading and validating the -wallet arguments and verifying the wallet database.
|
||||||
// This function will perform salvage on the wallet if requested, as long as only one wallet is
|
//! This function will perform salvage on the wallet if requested, as long as only one wallet is
|
||||||
// being loaded (WalletParameterInteraction forbids -salvagewallet, -zapwallettxes or -upgradewallet with multiwallet).
|
//! being loaded (WalletParameterInteraction forbids -salvagewallet, -zapwallettxes or -upgradewallet with multiwallet).
|
||||||
bool VerifyWallets(interfaces::Chain& chain, const std::vector<std::string>& wallet_files);
|
bool VerifyWallets(interfaces::Chain& chain, const std::vector<std::string>& wallet_files);
|
||||||
|
|
||||||
//! Load wallet databases.
|
//! Load wallet databases.
|
||||||
@@ -55,10 +55,10 @@ void StopWallets();
|
|||||||
void UnloadWallets();
|
void UnloadWallets();
|
||||||
|
|
||||||
//! Explicitly unload and delete the wallet.
|
//! Explicitly unload and delete the wallet.
|
||||||
// Blocks the current thread after signaling the unload intent so that all
|
//! Blocks the current thread after signaling the unload intent so that all
|
||||||
// wallet clients release the wallet.
|
//! wallet clients release the wallet.
|
||||||
// Note that, when blocking is not required, the wallet is implicitly unloaded
|
//! Note that, when blocking is not required, the wallet is implicitly unloaded
|
||||||
// by the shared pointer deleter.
|
//! by the shared pointer deleter.
|
||||||
void UnloadWallet(std::shared_ptr<CWallet>&& wallet);
|
void UnloadWallet(std::shared_ptr<CWallet>&& wallet);
|
||||||
|
|
||||||
bool AddWallet(const std::shared_ptr<CWallet>& wallet);
|
bool AddWallet(const std::shared_ptr<CWallet>& wallet);
|
||||||
@@ -588,8 +588,8 @@ public:
|
|||||||
int64_t nTimeCreated;
|
int64_t nTimeCreated;
|
||||||
int64_t nTimeExpires;
|
int64_t nTimeExpires;
|
||||||
std::string strComment;
|
std::string strComment;
|
||||||
//! todo: add something to note what created it (user, getnewaddress, change)
|
// todo: add something to note what created it (user, getnewaddress, change)
|
||||||
//! maybe should have a map<string, string> property map
|
// maybe should have a map<string, string> property map
|
||||||
|
|
||||||
explicit CWalletKey(int64_t nExpires=0);
|
explicit CWalletKey(int64_t nExpires=0);
|
||||||
|
|
||||||
|
|||||||
Reference in new issue
Block a user