Merge #14331: doxygen: Fix member comments
fa69ac7614
doxygen: Fix member comments (MarcoFalke)
Pull request description:
Trailing comments must be indicted with the caret `//!<`.
Not all places do this right now, see for example https://dev.visucore.com/bitcoin/doxygen/txmempool_8h.html#a2bc6653552b5871101b6cbefdbaf251f, but they can be fixed with an almost-scripted-diff:
```
sed -i --regexp-extended -e 's/((,|;) *\/\/!) /\1< /g' $(git grep --extended-regexp -l '(,|;)\s*//!\s')
```
(Same as [doxygen] Fix member comments #7793)
Tree-SHA512: 451077008353ccc6fcc795f34094b2d022feb7a171b562a07ba4de0dcb0aebc137e12b03970764bd81e2da386751d042903db4c4831900f43c0cfde804c81b2b
This commit is contained in:
commit
011c39c296
6 changed files with 32 additions and 32 deletions
|
@ -71,7 +71,7 @@ public:
|
||||||
void EvictExtraOutboundPeers(int64_t time_in_seconds) EXCLUSIVE_LOCKS_REQUIRED(cs_main);
|
void EvictExtraOutboundPeers(int64_t time_in_seconds) EXCLUSIVE_LOCKS_REQUIRED(cs_main);
|
||||||
|
|
||||||
private:
|
private:
|
||||||
int64_t m_stale_tip_check_time; //! Next time to check for stale tip
|
int64_t m_stale_tip_check_time; //!< Next time to check for stale tip
|
||||||
|
|
||||||
/** Enable BIP61 (sending reject messages) */
|
/** Enable BIP61 (sending reject messages) */
|
||||||
const bool m_enable_bip61;
|
const bool m_enable_bip61;
|
||||||
|
|
|
@ -191,10 +191,10 @@ enum SOCKSVersion: uint8_t {
|
||||||
|
|
||||||
/** Values defined for METHOD in RFC1928 */
|
/** Values defined for METHOD in RFC1928 */
|
||||||
enum SOCKS5Method: uint8_t {
|
enum SOCKS5Method: uint8_t {
|
||||||
NOAUTH = 0x00, //! No authentication required
|
NOAUTH = 0x00, //!< No authentication required
|
||||||
GSSAPI = 0x01, //! GSSAPI
|
GSSAPI = 0x01, //!< GSSAPI
|
||||||
USER_PASS = 0x02, //! Username/password
|
USER_PASS = 0x02, //!< Username/password
|
||||||
NO_ACCEPTABLE = 0xff, //! No acceptable methods
|
NO_ACCEPTABLE = 0xff, //!< No acceptable methods
|
||||||
};
|
};
|
||||||
|
|
||||||
/** Values defined for CMD in RFC1928 */
|
/** Values defined for CMD in RFC1928 */
|
||||||
|
@ -206,15 +206,15 @@ enum SOCKS5Command: uint8_t {
|
||||||
|
|
||||||
/** Values defined for REP in RFC1928 */
|
/** Values defined for REP in RFC1928 */
|
||||||
enum SOCKS5Reply: uint8_t {
|
enum SOCKS5Reply: uint8_t {
|
||||||
SUCCEEDED = 0x00, //! Succeeded
|
SUCCEEDED = 0x00, //!< Succeeded
|
||||||
GENFAILURE = 0x01, //! General failure
|
GENFAILURE = 0x01, //!< General failure
|
||||||
NOTALLOWED = 0x02, //! Connection not allowed by ruleset
|
NOTALLOWED = 0x02, //!< Connection not allowed by ruleset
|
||||||
NETUNREACHABLE = 0x03, //! Network unreachable
|
NETUNREACHABLE = 0x03, //!< Network unreachable
|
||||||
HOSTUNREACHABLE = 0x04, //! Network unreachable
|
HOSTUNREACHABLE = 0x04, //!< Network unreachable
|
||||||
CONNREFUSED = 0x05, //! Connection refused
|
CONNREFUSED = 0x05, //!< Connection refused
|
||||||
TTLEXPIRED = 0x06, //! TTL expired
|
TTLEXPIRED = 0x06, //!< TTL expired
|
||||||
CMDUNSUPPORTED = 0x07, //! Command not supported
|
CMDUNSUPPORTED = 0x07, //!< Command not supported
|
||||||
ATYPEUNSUPPORTED = 0x08, //! Address type not supported
|
ATYPEUNSUPPORTED = 0x08, //!< Address type not supported
|
||||||
};
|
};
|
||||||
|
|
||||||
/** Values defined for ATYPE in RFC1928 */
|
/** Values defined for ATYPE in RFC1928 */
|
||||||
|
|
|
@ -50,9 +50,9 @@ std::string StringForFeeReason(FeeReason reason);
|
||||||
|
|
||||||
/* Used to determine type of fee estimation requested */
|
/* Used to determine type of fee estimation requested */
|
||||||
enum class FeeEstimateMode {
|
enum class FeeEstimateMode {
|
||||||
UNSET, //! Use default settings based on other criteria
|
UNSET, //!< Use default settings based on other criteria
|
||||||
ECONOMICAL, //! Force estimateSmartFee to use non-conservative estimates
|
ECONOMICAL, //!< Force estimateSmartFee to use non-conservative estimates
|
||||||
CONSERVATIVE, //! Force estimateSmartFee to use conservative estimates
|
CONSERVATIVE, //!< Force estimateSmartFee to use conservative estimates
|
||||||
};
|
};
|
||||||
|
|
||||||
bool FeeModeFromString(const std::string& mode_string, FeeEstimateMode& fee_estimate_mode);
|
bool FeeModeFromString(const std::string& mode_string, FeeEstimateMode& fee_estimate_mode);
|
||||||
|
|
|
@ -64,7 +64,7 @@ public:
|
||||||
COutPoint prevout;
|
COutPoint prevout;
|
||||||
CScript scriptSig;
|
CScript scriptSig;
|
||||||
uint32_t nSequence;
|
uint32_t nSequence;
|
||||||
CScriptWitness scriptWitness; //! Only serialized through CTransaction
|
CScriptWitness scriptWitness; //!< Only serialized through CTransaction
|
||||||
|
|
||||||
/* Setting nSequence to this value for every input in a transaction
|
/* Setting nSequence to this value for every input in a transaction
|
||||||
* disables nLockTime. */
|
* disables nLockTime. */
|
||||||
|
|
|
@ -23,9 +23,9 @@ namespace {
|
||||||
*/
|
*/
|
||||||
enum class IsMineSigVersion
|
enum class IsMineSigVersion
|
||||||
{
|
{
|
||||||
TOP = 0, //! scriptPubKey execution
|
TOP = 0, //!< scriptPubKey execution
|
||||||
P2SH = 1, //! P2SH redeemScript
|
P2SH = 1, //!< P2SH redeemScript
|
||||||
WITNESS_V0 = 2 //! P2WSH witness script execution
|
WITNESS_V0 = 2, //!< P2WSH witness script execution
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -35,10 +35,10 @@ enum class IsMineSigVersion
|
||||||
*/
|
*/
|
||||||
enum class IsMineResult
|
enum class IsMineResult
|
||||||
{
|
{
|
||||||
NO = 0, //! Not ours
|
NO = 0, //!< Not ours
|
||||||
WATCH_ONLY = 1, //! Included in watch-only balance
|
WATCH_ONLY = 1, //!< Included in watch-only balance
|
||||||
SPENDABLE = 2, //! Included in all balances
|
SPENDABLE = 2, //!< Included in all balances
|
||||||
INVALID = 3, //! Not spendable by anyone (uncompressed pubkey in segwit, P2SH inside P2SH or witness, witness inside witness)
|
INVALID = 3, //!< Not spendable by anyone (uncompressed pubkey in segwit, P2SH inside P2SH or witness, witness inside witness)
|
||||||
};
|
};
|
||||||
|
|
||||||
bool PermitsUncompressed(IsMineSigVersion sigversion)
|
bool PermitsUncompressed(IsMineSigVersion sigversion)
|
||||||
|
|
|
@ -343,13 +343,13 @@ struct TxMempoolInfo
|
||||||
* this is passed to the notification signal.
|
* this is passed to the notification signal.
|
||||||
*/
|
*/
|
||||||
enum class MemPoolRemovalReason {
|
enum class MemPoolRemovalReason {
|
||||||
UNKNOWN = 0, //! Manually removed or unknown reason
|
UNKNOWN = 0, //!< Manually removed or unknown reason
|
||||||
EXPIRY, //! Expired from mempool
|
EXPIRY, //!< Expired from mempool
|
||||||
SIZELIMIT, //! Removed in size limiting
|
SIZELIMIT, //!< Removed in size limiting
|
||||||
REORG, //! Removed for reorganization
|
REORG, //!< Removed for reorganization
|
||||||
BLOCK, //! Removed for block
|
BLOCK, //!< Removed for block
|
||||||
CONFLICT, //! Removed for conflict with in-block transaction
|
CONFLICT, //!< Removed for conflict with in-block transaction
|
||||||
REPLACED //! Removed for replacement
|
REPLACED, //!< Removed for replacement
|
||||||
};
|
};
|
||||||
|
|
||||||
class SaltedTxidHasher
|
class SaltedTxidHasher
|
||||||
|
|
Loading…
Reference in a new issue