Skip to content

Commit 569e449

Browse files
MarcoFalkePastaPastaPasta
MarcoFalke
authored andcommitted
Merge bitcoin#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 bitcoin#7793) Tree-SHA512: 451077008353ccc6fcc795f34094b2d022feb7a171b562a07ba4de0dcb0aebc137e12b03970764bd81e2da386751d042903db4c4831900f43c0cfde804c81b2b
1 parent 1ccb576 commit 569e449

File tree

4 files changed

+23
-23
lines changed

4 files changed

+23
-23
lines changed

Diff for: src/net_processing.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ class PeerLogicValidation final : public CValidationInterface, public NetEventsI
7575
void EvictExtraOutboundPeers(int64_t time_in_seconds) EXCLUSIVE_LOCKS_REQUIRED(cs_main);
7676

7777
private:
78-
int64_t m_stale_tip_check_time; //! Next time to check for stale tip
78+
int64_t m_stale_tip_check_time; //!< Next time to check for stale tip
7979

8080
/** Enable BIP61 (sending reject messages) */
8181
const bool m_enable_bip61;

Diff for: src/netbase.cpp

+13-13
Original file line numberDiff line numberDiff line change
@@ -197,10 +197,10 @@ enum SOCKSVersion: uint8_t {
197197

198198
/** Values defined for METHOD in RFC1928 */
199199
enum SOCKS5Method: uint8_t {
200-
NOAUTH = 0x00, //! No authentication required
201-
GSSAPI = 0x01, //! GSSAPI
202-
USER_PASS = 0x02, //! Username/password
203-
NO_ACCEPTABLE = 0xff, //! No acceptable methods
200+
NOAUTH = 0x00, //!< No authentication required
201+
GSSAPI = 0x01, //!< GSSAPI
202+
USER_PASS = 0x02, //!< Username/password
203+
NO_ACCEPTABLE = 0xff, //!< No acceptable methods
204204
};
205205

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

213213
/** Values defined for REP in RFC1928 */
214214
enum SOCKS5Reply: uint8_t {
215-
SUCCEEDED = 0x00, //! Succeeded
216-
GENFAILURE = 0x01, //! General failure
217-
NOTALLOWED = 0x02, //! Connection not allowed by ruleset
218-
NETUNREACHABLE = 0x03, //! Network unreachable
219-
HOSTUNREACHABLE = 0x04, //! Network unreachable
220-
CONNREFUSED = 0x05, //! Connection refused
221-
TTLEXPIRED = 0x06, //! TTL expired
222-
CMDUNSUPPORTED = 0x07, //! Command not supported
223-
ATYPEUNSUPPORTED = 0x08, //! Address type not supported
215+
SUCCEEDED = 0x00, //!< Succeeded
216+
GENFAILURE = 0x01, //!< General failure
217+
NOTALLOWED = 0x02, //!< Connection not allowed by ruleset
218+
NETUNREACHABLE = 0x03, //!< Network unreachable
219+
HOSTUNREACHABLE = 0x04, //!< Network unreachable
220+
CONNREFUSED = 0x05, //!< Connection refused
221+
TTLEXPIRED = 0x06, //!< TTL expired
222+
CMDUNSUPPORTED = 0x07, //!< Command not supported
223+
ATYPEUNSUPPORTED = 0x08, //!< Address type not supported
224224
};
225225

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

Diff for: src/policy/fees.h

+3-3
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);

Diff for: src/txmempool.h

+6-6
Original file line numberDiff line numberDiff line change
@@ -352,12 +352,12 @@ struct TxMempoolInfo
352352
* this is passed to the notification signal.
353353
*/
354354
enum class MemPoolRemovalReason {
355-
UNKNOWN = 0, //! Manually removed or unknown reason
356-
EXPIRY, //! Expired from mempool
357-
SIZELIMIT, //! Removed in size limiting
358-
REORG, //! Removed for reorganization
359-
BLOCK, //! Removed for block
360-
CONFLICT, //! Removed for conflict with in-block transaction
355+
UNKNOWN = 0, //!< Manually removed or unknown reason
356+
EXPIRY, //!< Expired from mempool
357+
SIZELIMIT, //!< Removed in size limiting
358+
REORG, //!< Removed for reorganization
359+
BLOCK, //!< Removed for block
360+
CONFLICT, //!< Removed for conflict with in-block transaction
361361
};
362362

363363
class SaltedTxidHasher

0 commit comments

Comments
 (0)