laantungir
/
bitcoin
mirror of https://github.com/bitcoin/bitcoin.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: Remove wrong and redundant doxygen tag 

Remove it in feerate.

Fix it in the other places.

Github-Pull: #33236
Rebased-From: 966666de9a
This commit is contained in:
MarcoFalke 2025-08-21 14:04:03 +02:00 committed by fanquake
parent 162c009c1d
commit 6448ebb5a7
No known key found for this signature in database
GPG Key ID: 2EEB9F5CC09526C1
3 changed files with 22 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/policy/feerate.h
View File

@ -44,9 +44,6 @@ public:
/** /**
* Construct a fee rate from a fee in satoshis and a vsize in vB. * Construct a fee rate from a fee in satoshis and a vsize in vB.
*
* param@[in] nFeePaid The fee paid by a transaction, in satoshis
* param@[in] num_bytes The vsize of a transaction, in vbytes
*/ */
CFeeRate(const CAmount& nFeePaid, uint32_t num_bytes); CFeeRate(const CAmount& nFeePaid, uint32_t num_bytes);

14
src/wallet/coinselection.cpp
View File

@ -589,15 +589,15 @@ util::Result<SelectionResult> SelectCoinsSRD(const std::vector<OutputGroup>& utx
/** Find a subset of the OutputGroups that is at least as large as, but as close as possible to, the /** Find a subset of the OutputGroups that is at least as large as, but as close as possible to, the
* target amount; solve subset sum. * target amount; solve subset sum.
* param@[in] groups OutputGroups to choose from, sorted by value in descending order. * @param[in] groups OutputGroups to choose from, sorted by value in descending order.
* param@[in] nTotalLower Total (effective) value of the UTXOs in groups. * @param[in] nTotalLower Total (effective) value of the UTXOs in groups.
* param@[in] nTargetValue Subset sum target, not including change. * @param[in] nTargetValue Subset sum target, not including change.
* param@[out] vfBest Boolean vector representing the subset chosen that is closest to * @param[out] vfBest Boolean vector representing the subset chosen that is closest to
* nTargetValue, with indices corresponding to groups. If the ith * nTargetValue, with indices corresponding to groups. If the ith
* entry is true, that means the ith group in groups was selected. * entry is true, that means the ith group in groups was selected.
* param@[out] nBest Total amount of subset chosen that is closest to nTargetValue. * @param[out] nBest Total amount of subset chosen that is closest to nTargetValue.
* paramp[in] max_selection_weight The maximum allowed weight for a selection result to be valid. * @param[in] max_selection_weight The maximum allowed weight for a selection result to be valid.
* param@[in] iterations Maximum number of tries. * @param[in] iterations Maximum number of tries.
*/ */
static void ApproximateBestSubset(FastRandomContext& insecure_rand, const std::vector<OutputGroup>& groups, static void ApproximateBestSubset(FastRandomContext& insecure_rand, const std::vector<OutputGroup>& groups,
const CAmount& nTotalLower, const CAmount& nTargetValue, const CAmount& nTotalLower, const CAmount& nTargetValue,

30
src/wallet/spend.h
View File

@ -123,14 +123,14 @@ FilteredOutputGroups GroupOutputs(const CWallet& wallet,
* the solution (according to the waste metric) will be chosen. If a valid input cannot be found from any * the solution (according to the waste metric) will be chosen. If a valid input cannot be found from any
* single OutputType, fallback to running `ChooseSelectionResult()` over all available coins. * single OutputType, fallback to running `ChooseSelectionResult()` over all available coins.
* *
* param@[in] chain The chain interface to get information on unconfirmed UTXOs bump fees * @param[in] chain The chain interface to get information on bump fees for unconfirmed UTXOs
* param@[in] nTargetValue The target value * @param[in] nTargetValue The target value
* param@[in] groups The grouped outputs mapped by coin eligibility filters * @param[in] groups The grouped outputs mapped by coin eligibility filters
* param@[in] coin_selection_params Parameters for the coin selection * @param[in] coin_selection_params Parameters for the coin selection
* param@[in] allow_mixed_output_types Relax restriction that SelectionResults must be of the same OutputType * @param[in] allow_mixed_output_types Relax restriction that SelectionResults must be of the same OutputType
* returns If successful, a SelectionResult containing the input set * returns If successful, a SelectionResult containing the input set
* If failed, returns (1) an empty error message if the target was not reached (general "Insufficient funds") * If failed, returns (1) an empty error message if the target was not reached (general "Insufficient funds")
* or (2) an specific error message if there was something particularly wrong (e.g. a selection * or (2) a specific error message if there was something particularly wrong (e.g. a selection
* result that surpassed the tx max weight size). * result that surpassed the tx max weight size).
*/ */
util::Result<SelectionResult> AttemptSelection(interfaces::Chain& chain, const CAmount& nTargetValue, OutputGroupTypeMap& groups, util::Result<SelectionResult> AttemptSelection(interfaces::Chain& chain, const CAmount& nTargetValue, OutputGroupTypeMap& groups,
@ -141,13 +141,13 @@ util::Result<SelectionResult> AttemptSelection(interfaces::Chain& chain, const C
* Multiple coin selection algorithms will be run and the input set that produces the least waste * Multiple coin selection algorithms will be run and the input set that produces the least waste
* (according to the waste metric) will be chosen. * (according to the waste metric) will be chosen.
* *
* param@[in] chain The chain interface to get information on unconfirmed UTXOs bump fees * @param[in] chain The chain interface to get information on bump fees for unconfirmed UTXOs
* param@[in] nTargetValue The target value * @param[in] nTargetValue The target value
* param@[in] groups The struct containing the outputs grouped by script and divided by (1) positive only outputs and (2) all outputs (positive + negative). * @param[in] groups The struct containing the outputs grouped by script and divided by (1) positive only outputs and (2) all outputs (positive + negative).
* param@[in] coin_selection_params Parameters for the coin selection * @param[in] coin_selection_params Parameters for the coin selection
* returns If successful, a SelectionResult containing the input set * returns If successful, a SelectionResult containing the input set
* If failed, returns (1) an empty error message if the target was not reached (general "Insufficient funds") * If failed, returns (1) an empty error message if the target was not reached (general "Insufficient funds")
* or (2) an specific error message if there was something particularly wrong (e.g. a selection * or (2) a specific error message if there was something particularly wrong (e.g. a selection
* result that surpassed the tx max weight size). * result that surpassed the tx max weight size).
*/ */
util::Result<SelectionResult> ChooseSelectionResult(interfaces::Chain& chain, const CAmount& nTargetValue, Groups& groups, const CoinSelectionParams& coin_selection_params); util::Result<SelectionResult> ChooseSelectionResult(interfaces::Chain& chain, const CAmount& nTargetValue, Groups& groups, const CoinSelectionParams& coin_selection_params);
@ -181,10 +181,10 @@ util::Result<PreSelectedInputs> FetchSelectedInputs(const CWallet& wallet, const
/** /**
* Select a set of coins such that nTargetValue is met; never select unconfirmed coins if they are not ours * Select a set of coins such that nTargetValue is met; never select unconfirmed coins if they are not ours
* param@[in] wallet The wallet which provides data necessary to spend the selected coins * @param[in] wallet The wallet which provides data necessary to spend the selected coins
* param@[in] available_coins The struct of coins, organized by OutputType, available for selection prior to filtering * @param[in] available_coins The struct of coins, organized by OutputType, available for selection prior to filtering
* param@[in] nTargetValue The target value * @param[in] nTargetValue The target value
* param@[in] coin_selection_params Parameters for this coin selection such as feerates, whether to avoid partial spends, * @param[in] coin_selection_params Parameters for this coin selection such as feerates, whether to avoid partial spends,
* and whether to subtract the fee from the outputs. * and whether to subtract the fee from the outputs.
* returns If successful, a SelectionResult containing the selected coins * returns If successful, a SelectionResult containing the selected coins
* If failed, returns (1) an empty error message if the target was not reached (general "Insufficient funds") * If failed, returns (1) an empty error message if the target was not reached (general "Insufficient funds")