mirror of
https://github.com/dashpay/dash.git
synced 2024-12-24 19:42:46 +01:00
fix: adjust doxygen for dash codebase for -Wdocumentation
This commit is contained in:
parent
4f260cd4b1
commit
252ffee815
@ -107,7 +107,7 @@ public:
|
||||
/**
|
||||
* Return the elapsed time.
|
||||
*
|
||||
* @param duration_t
|
||||
* @tparam duration_t
|
||||
* The duration type used to return the time elapsed. If not
|
||||
* specified, it returns the time as represented by
|
||||
* std::chrono::milliseconds.
|
||||
|
@ -61,7 +61,7 @@ private:
|
||||
|
||||
public:
|
||||
/**
|
||||
* @param[in] parent CDBWrapper that this batch is to be submitted to
|
||||
* @param[in] _parent CDBWrapper that this batch is to be submitted to
|
||||
*/
|
||||
explicit CDBBatch(const CDBWrapper &_parent) : parent(_parent), ssKey(SER_DISK, CLIENT_VERSION), ssValue(SER_DISK, CLIENT_VERSION), size_estimate(0) { };
|
||||
|
||||
|
@ -346,15 +346,11 @@ public:
|
||||
* Calculates the projected MN payees for the next *count* blocks. The result is not guaranteed to be correct
|
||||
* as PoSe banning might occur later
|
||||
* @param nCount the number of payees to return. "nCount = max()"" means "all", use it to avoid calling GetValidWeightedMNsCount twice.
|
||||
* @return
|
||||
*/
|
||||
[[nodiscard]] std::vector<CDeterministicMNCPtr> GetProjectedMNPayees(gsl::not_null<const CBlockIndex* const> pindexPrev, int nCount = std::numeric_limits<int>::max()) const;
|
||||
|
||||
/**
|
||||
* Calculate a quorum based on the modifier. The resulting list is deterministically sorted by score
|
||||
* @param maxSize
|
||||
* @param modifier
|
||||
* @return
|
||||
*/
|
||||
[[nodiscard]] std::vector<CDeterministicMNCPtr> CalculateQuorum(size_t maxSize, const uint256& modifier, const bool onlyEvoNodes = false) const;
|
||||
[[nodiscard]] std::vector<std::pair<arith_uint256, CDeterministicMNCPtr>> CalculateScores(const uint256& modifier, const bool onlyEvoNodes) const;
|
||||
@ -362,7 +358,6 @@ public:
|
||||
/**
|
||||
* Calculates the maximum penalty which is allowed at the height of this MN list. It is dynamic and might change
|
||||
* for every block.
|
||||
* @return
|
||||
*/
|
||||
[[nodiscard]] int CalcMaxPoSePenalty() const;
|
||||
|
||||
@ -371,8 +366,6 @@ public:
|
||||
* value later passed to PoSePunish. The percentage should be high enough to take per-block penalty decreasing for MNs
|
||||
* into account. This means, if you want to accept 2 failures per payment cycle, you should choose a percentage that
|
||||
* is higher then 50%, e.g. 66%.
|
||||
* @param percent
|
||||
* @return
|
||||
*/
|
||||
[[nodiscard]] int CalcPenalty(int percent) const;
|
||||
|
||||
@ -380,8 +373,6 @@ public:
|
||||
* Punishes a MN for misbehavior. If the resulting penalty score of the MN reaches the max penalty, it is banned.
|
||||
* Penalty scores are only increased when the MN is not already banned, which means that after banning the penalty
|
||||
* might appear lower then the current max penalty, while the MN is still banned.
|
||||
* @param proTxHash
|
||||
* @param penalty
|
||||
*/
|
||||
void PoSePunish(const uint256& proTxHash, int penalty, bool debugLogs);
|
||||
|
||||
|
@ -36,7 +36,6 @@ static const CFeeRate DEFAULT_MAX_RAW_TX_FEE_RATE{COIN / 10};
|
||||
* @param[in] node reference to node context
|
||||
* @param[in] tx the transaction to broadcast
|
||||
* @param[out] err_string reference to std::string to fill with error string if available
|
||||
* @param[in] max_tx_fee reject txs with fees higher than this (if 0, accept any fee)
|
||||
* @param[in] relay flag if both mempool insertion and p2p relay are requested
|
||||
* @param[in] wait_callback wait until callbacks have been processed to avoid stale result due to a sequentially RPC.
|
||||
* return error
|
||||
|
@ -19,7 +19,6 @@ class SigningProvider;
|
||||
* Sign a transaction with the given keystore and previous transactions
|
||||
*
|
||||
* @param mtx The transaction to-be-signed
|
||||
* @param prevTxsUnival Array of previous txns outputs that tx depends on but may not yet be in the block chain
|
||||
* @param keystore Temporary keystore containing signing keys
|
||||
* @param coins Map of unspent outputs
|
||||
* @param hashType The signature hash type
|
||||
@ -31,7 +30,7 @@ void SignTransactionResultToJSON(CMutableTransaction& mtx, bool complete, const
|
||||
/**
|
||||
* Parse a prevtxs UniValue array and get the map of coins from it
|
||||
*
|
||||
* @param prevTxs Array of previous txns outputs that tx depends on but may not yet be in the block chain
|
||||
* @param prevTxsUnival Array of previous txns outputs that tx depends on but may not yet be in the block chain
|
||||
* @param keystore A pointer to the temprorary keystore if there is one
|
||||
* @param coins Map of unspent outputs - coins in mempool and current chain UTXO set, may be extended by previous txns outputs after call
|
||||
*/
|
||||
|
@ -10,7 +10,7 @@
|
||||
/**
|
||||
* similar to python's enumerate(iterable).
|
||||
* @tparam T type of iterable, automatically deduced
|
||||
* @tparam TIter
|
||||
* @tparam TIter begin of containter
|
||||
* @param iterable an iterable object, can be a temporary
|
||||
* @return struct containing a size_t index, and it's element in iterable
|
||||
*/
|
||||
|
@ -1099,7 +1099,6 @@ public:
|
||||
* @param[out] state This may be set to an Error state if any error occurred processing them
|
||||
* @param[in] chainparams The params for the chain we want to connect to
|
||||
* @param[out] ppindex If set, the pointer will be set to point to the last new block index object for the given headers
|
||||
* @param[out] first_invalid First header that fails validation, if one exists
|
||||
*/
|
||||
bool ProcessNewBlockHeaders(const std::vector<CBlockHeader>& block, BlockValidationState& state, const CChainParams& chainparams, const CBlockIndex** ppindex = nullptr) LOCKS_EXCLUDED(cs_main);
|
||||
|
||||
|
@ -1348,7 +1348,7 @@ static void MaybePushAddress(UniValue & entry, const CTxDestination &dest)
|
||||
/**
|
||||
* List transactions based on the given criteria.
|
||||
*
|
||||
* @param wallet The wallet.
|
||||
* @param pwallet The wallet.
|
||||
* @param wtx The wallet transaction.
|
||||
* @param nMinDepth The minimum confirmation depth.
|
||||
* @param fLong Whether to include the JSON version of the transaction.
|
||||
|
@ -250,7 +250,7 @@ private:
|
||||
CryptedKeyMap mapCryptedKeys GUARDED_BY(cs_KeyStore);
|
||||
WatchOnlySet setWatchOnly GUARDED_BY(cs_KeyStore);
|
||||
WatchKeyMap mapWatchKeys GUARDED_BY(cs_KeyStore);
|
||||
HDPubKeyMap mapHdPubKeys GUARDED_BY(cs_KeyStore); //<! memory map of HD extended pubkeys
|
||||
HDPubKeyMap mapHdPubKeys GUARDED_BY(cs_KeyStore); ///<! memory map of HD extended pubkeys
|
||||
|
||||
int64_t nTimeFirstKey GUARDED_BY(cs_KeyStore) = 0;
|
||||
|
||||
|
@ -1408,7 +1408,7 @@ public:
|
||||
//! Returns all unique ScriptPubKeyMans
|
||||
std::set<ScriptPubKeyMan*> GetAllScriptPubKeyMans() const;
|
||||
|
||||
//! Get the ScriptPubKeyMan for the given OutputType and internal/external chain.
|
||||
//! Get the ScriptPubKeyMan for internal/external chain.
|
||||
ScriptPubKeyMan* GetScriptPubKeyMan(bool internal) const;
|
||||
|
||||
//! Get the ScriptPubKeyMan for a script
|
||||
@ -1472,7 +1472,6 @@ public:
|
||||
|
||||
//! Remove specified ScriptPubKeyMan from set of active SPK managers. Writes the change to the wallet file.
|
||||
//! @param[in] id The unique id for the ScriptPubKeyMan
|
||||
//! @param[in] type The OutputType this ScriptPubKeyMan provides addresses for
|
||||
//! @param[in] internal Whether this ScriptPubKeyMan provides change addresses
|
||||
void DeactivateScriptPubKeyMan(uint256 id, bool internal);
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user