Skip to content

Commit 011c39c

Browse files
author
MarcoFalke
committed
Merge #14331: doxygen: Fix member comments
fa69ac7 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
2 parents c932730 + fa69ac7 commit 011c39c

File tree

6 files changed

+32
-32
lines changed

6 files changed

+32
-32
lines changed

src/net_processing.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ class PeerLogicValidation final : public CValidationInterface, public NetEventsI
7171
void EvictExtraOutboundPeers(int64_t time_in_seconds) EXCLUSIVE_LOCKS_REQUIRED(cs_main);
7272

7373
private:
74-
int64_t m_stale_tip_check_time; //! Next time to check for stale tip
74+
int64_t m_stale_tip_check_time; //!< Next time to check for stale tip
7575

7676
/** Enable BIP61 (sending reject messages) */
7777
const bool m_enable_bip61;

src/netbase.cpp

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -191,10 +191,10 @@ enum SOCKSVersion: uint8_t {
191191

192192
/** Values defined for METHOD in RFC1928 */
193193
enum SOCKS5Method: uint8_t {
194-
NOAUTH = 0x00, //! No authentication required
195-
GSSAPI = 0x01, //! GSSAPI
196-
USER_PASS = 0x02, //! Username/password
197-
NO_ACCEPTABLE = 0xff, //! No acceptable methods
194+
NOAUTH = 0x00, //!< No authentication required
195+
GSSAPI = 0x01, //!< GSSAPI
196+
USER_PASS = 0x02, //!< Username/password
197+
NO_ACCEPTABLE = 0xff, //!< No acceptable methods
198198
};
199199

200200
/** Values defined for CMD in RFC1928 */
@@ -206,15 +206,15 @@ enum SOCKS5Command: uint8_t {
206206

207207
/** Values defined for REP in RFC1928 */
208208
enum SOCKS5Reply: uint8_t {
209-
SUCCEEDED = 0x00, //! Succeeded
210-
GENFAILURE = 0x01, //! General failure
211-
NOTALLOWED = 0x02, //! Connection not allowed by ruleset
212-
NETUNREACHABLE = 0x03, //! Network unreachable
213-
HOSTUNREACHABLE = 0x04, //! Network unreachable
214-
CONNREFUSED = 0x05, //! Connection refused
215-
TTLEXPIRED = 0x06, //! TTL expired
216-
CMDUNSUPPORTED = 0x07, //! Command not supported
217-
ATYPEUNSUPPORTED = 0x08, //! Address type not supported
209+
SUCCEEDED = 0x00, //!< Succeeded
210+
GENFAILURE = 0x01, //!< General failure
211+
NOTALLOWED = 0x02, //!< Connection not allowed by ruleset
212+
NETUNREACHABLE = 0x03, //!< Network unreachable
213+
HOSTUNREACHABLE = 0x04, //!< Network unreachable
214+
CONNREFUSED = 0x05, //!< Connection refused
215+
TTLEXPIRED = 0x06, //!< TTL expired
216+
CMDUNSUPPORTED = 0x07, //!< Command not supported
217+
ATYPEUNSUPPORTED = 0x08, //!< Address type not supported
218218
};
219219

220220
/** Values defined for ATYPE in RFC1928 */

src/policy/fees.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,9 @@ std::string StringForFeeReason(FeeReason reason);
5050

5151
/* Used to determine type of fee estimation requested */
5252
enum class FeeEstimateMode {
53-
UNSET, //! Use default settings based on other criteria
54-
ECONOMICAL, //! Force estimateSmartFee to use non-conservative estimates
55-
CONSERVATIVE, //! Force estimateSmartFee to use conservative estimates
53+
UNSET, //!< Use default settings based on other criteria
54+
ECONOMICAL, //!< Force estimateSmartFee to use non-conservative estimates
55+
CONSERVATIVE, //!< Force estimateSmartFee to use conservative estimates
5656
};
5757

5858
bool FeeModeFromString(const std::string& mode_string, FeeEstimateMode& fee_estimate_mode);

src/primitives/transaction.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ class CTxIn
6464
COutPoint prevout;
6565
CScript scriptSig;
6666
uint32_t nSequence;
67-
CScriptWitness scriptWitness; //! Only serialized through CTransaction
67+
CScriptWitness scriptWitness; //!< Only serialized through CTransaction
6868

6969
/* Setting nSequence to this value for every input in a transaction
7070
* disables nLockTime. */

src/script/ismine.cpp

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ namespace {
2323
*/
2424
enum class IsMineSigVersion
2525
{
26-
TOP = 0, //! scriptPubKey execution
27-
P2SH = 1, //! P2SH redeemScript
28-
WITNESS_V0 = 2 //! P2WSH witness script execution
26+
TOP = 0, //!< scriptPubKey execution
27+
P2SH = 1, //!< P2SH redeemScript
28+
WITNESS_V0 = 2, //!< P2WSH witness script execution
2929
};
3030

3131
/**
@@ -35,10 +35,10 @@ enum class IsMineSigVersion
3535
*/
3636
enum class IsMineResult
3737
{
38-
NO = 0, //! Not ours
39-
WATCH_ONLY = 1, //! Included in watch-only balance
40-
SPENDABLE = 2, //! Included in all balances
41-
INVALID = 3, //! Not spendable by anyone (uncompressed pubkey in segwit, P2SH inside P2SH or witness, witness inside witness)
38+
NO = 0, //!< Not ours
39+
WATCH_ONLY = 1, //!< Included in watch-only balance
40+
SPENDABLE = 2, //!< Included in all balances
41+
INVALID = 3, //!< Not spendable by anyone (uncompressed pubkey in segwit, P2SH inside P2SH or witness, witness inside witness)
4242
};
4343

4444
bool PermitsUncompressed(IsMineSigVersion sigversion)

src/txmempool.h

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -343,13 +343,13 @@ struct TxMempoolInfo
343343
* this is passed to the notification signal.
344344
*/
345345
enum class MemPoolRemovalReason {
346-
UNKNOWN = 0, //! Manually removed or unknown reason
347-
EXPIRY, //! Expired from mempool
348-
SIZELIMIT, //! Removed in size limiting
349-
REORG, //! Removed for reorganization
350-
BLOCK, //! Removed for block
351-
CONFLICT, //! Removed for conflict with in-block transaction
352-
REPLACED //! Removed for replacement
346+
UNKNOWN = 0, //!< Manually removed or unknown reason
347+
EXPIRY, //!< Expired from mempool
348+
SIZELIMIT, //!< Removed in size limiting
349+
REORG, //!< Removed for reorganization
350+
BLOCK, //!< Removed for block
351+
CONFLICT, //!< Removed for conflict with in-block transaction
352+
REPLACED, //!< Removed for replacement
353353
};
354354

355355
class SaltedTxidHasher

0 commit comments

Comments
 (0)