Skip to content

Commit fa27c0a

Browse files
author
MarcoFalke
committed
[doc] Fix typos in comments, doxygen: Fix comment syntax
1 parent fabfd5d commit fa27c0a

File tree

5 files changed

+37
-37
lines changed

5 files changed

+37
-37
lines changed

‎src/chain.h‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -137,15 +137,15 @@ enum BlockStatus: uint32_t {
137137
BLOCK_VALID_MASK = BLOCK_VALID_HEADER | BLOCK_VALID_TREE | BLOCK_VALID_TRANSACTIONS |
138138
BLOCK_VALID_CHAIN | BLOCK_VALID_SCRIPTS,
139139

140-
BLOCK_HAVE_DATA = 8, //! full block available in blk*.dat
141-
BLOCK_HAVE_UNDO = 16, //! undo data available in rev*.dat
140+
BLOCK_HAVE_DATA = 8, //!< full block available in blk*.dat
141+
BLOCK_HAVE_UNDO = 16, //!< undo data available in rev*.dat
142142
BLOCK_HAVE_MASK = BLOCK_HAVE_DATA | BLOCK_HAVE_UNDO,
143143

144-
BLOCK_FAILED_VALID = 32, //! stage after last reached validness failed
145-
BLOCK_FAILED_CHILD = 64, //! descends from failed block
144+
BLOCK_FAILED_VALID = 32, //!< stage after last reached validness failed
145+
BLOCK_FAILED_CHILD = 64, //!< descends from failed block
146146
BLOCK_FAILED_MASK = BLOCK_FAILED_VALID | BLOCK_FAILED_CHILD,
147147

148-
BLOCK_OPT_WITNESS = 128, //! block data in blk*.data was received with a witness-enforcing client
148+
BLOCK_OPT_WITNESS = 128, //!< block data in blk*.data was received with a witness-enforcing client
149149
};
150150

151151
/** The block chain is a tree shaped structure starting with the

‎src/consensus/validation.h‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ static const unsigned char REJECT_CHECKPOINT = 0x43;
2222
class CValidationState {
2323
private:
2424
enum mode_state {
25-
MODE_VALID, //! everything ok
26-
MODE_INVALID, //! network rule violation (DoS value may be set)
27-
MODE_ERROR, //! run-time error
25+
MODE_VALID, //!< everything ok
26+
MODE_INVALID, //!< network rule violation (DoS value may be set)
27+
MODE_ERROR, //!< run-time error
2828
} mode;
2929
int nDoS;
3030
std::string strRejectReason;

‎src/rpc/protocol.h‎

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -38,42 +38,42 @@ enum RPCErrorCode
3838
RPC_PARSE_ERROR = -32700,
3939

4040
//! General application defined errors
41-
RPC_MISC_ERROR = -1, //! std::exception thrown in command handling
42-
RPC_FORBIDDEN_BY_SAFE_MODE = -2, //! Server is in safe mode, and command is not allowed in safe mode
43-
RPC_TYPE_ERROR = -3, //! Unexpected type was passed as parameter
44-
RPC_INVALID_ADDRESS_OR_KEY = -5, //! Invalid address or key
45-
RPC_OUT_OF_MEMORY = -7, //! Ran out of memory during operation
46-
RPC_INVALID_PARAMETER = -8, //! Invalid, missing or duplicate parameter
47-
RPC_DATABASE_ERROR = -20, //! Database error
48-
RPC_DESERIALIZATION_ERROR = -22, //! Error parsing or validating structure in raw format
49-
RPC_VERIFY_ERROR = -25, //! General error during transaction or block submission
50-
RPC_VERIFY_REJECTED = -26, //! Transaction or block was rejected by network rules
51-
RPC_VERIFY_ALREADY_IN_CHAIN = -27, //! Transaction already in chain
52-
RPC_IN_WARMUP = -28, //! Client still warming up
41+
RPC_MISC_ERROR = -1, //!< std::exception thrown in command handling
42+
RPC_FORBIDDEN_BY_SAFE_MODE = -2, //!< Server is in safe mode, and command is not allowed in safe mode
43+
RPC_TYPE_ERROR = -3, //!< Unexpected type was passed as parameter
44+
RPC_INVALID_ADDRESS_OR_KEY = -5, //!< Invalid address or key
45+
RPC_OUT_OF_MEMORY = -7, //!< Ran out of memory during operation
46+
RPC_INVALID_PARAMETER = -8, //!< Invalid, missing or duplicate parameter
47+
RPC_DATABASE_ERROR = -20, //!< Database error
48+
RPC_DESERIALIZATION_ERROR = -22, //!< Error parsing or validating structure in raw format
49+
RPC_VERIFY_ERROR = -25, //!< General error during transaction or block submission
50+
RPC_VERIFY_REJECTED = -26, //!< Transaction or block was rejected by network rules
51+
RPC_VERIFY_ALREADY_IN_CHAIN = -27, //!< Transaction already in chain
52+
RPC_IN_WARMUP = -28, //!< Client still warming up
5353

5454
//! Aliases for backward compatibility
5555
RPC_TRANSACTION_ERROR = RPC_VERIFY_ERROR,
5656
RPC_TRANSACTION_REJECTED = RPC_VERIFY_REJECTED,
5757
RPC_TRANSACTION_ALREADY_IN_CHAIN= RPC_VERIFY_ALREADY_IN_CHAIN,
5858

5959
//! P2P client errors
60-
RPC_CLIENT_NOT_CONNECTED = -9, //! Bitcoin is not connected
61-
RPC_CLIENT_IN_INITIAL_DOWNLOAD = -10, //! Still downloading initial blocks
62-
RPC_CLIENT_NODE_ALREADY_ADDED = -23, //! Node is already added
63-
RPC_CLIENT_NODE_NOT_ADDED = -24, //! Node has not been added before
64-
RPC_CLIENT_NODE_NOT_CONNECTED = -29, //! Node to disconnect not found in connected nodes
65-
RPC_CLIENT_INVALID_IP_OR_SUBNET = -30, //! Invalid IP/Subnet
60+
RPC_CLIENT_NOT_CONNECTED = -9, //!< Bitcoin is not connected
61+
RPC_CLIENT_IN_INITIAL_DOWNLOAD = -10, //!< Still downloading initial blocks
62+
RPC_CLIENT_NODE_ALREADY_ADDED = -23, //!< Node is already added
63+
RPC_CLIENT_NODE_NOT_ADDED = -24, //!< Node has not been added before
64+
RPC_CLIENT_NODE_NOT_CONNECTED = -29, //!< Node to disconnect not found in connected nodes
65+
RPC_CLIENT_INVALID_IP_OR_SUBNET = -30, //!< Invalid IP/Subnet
6666

6767
//! Wallet errors
68-
RPC_WALLET_ERROR = -4, //! Unspecified problem with wallet (key not found etc.)
69-
RPC_WALLET_INSUFFICIENT_FUNDS = -6, //! Not enough funds in wallet or account
70-
RPC_WALLET_INVALID_ACCOUNT_NAME = -11, //! Invalid account name
71-
RPC_WALLET_KEYPOOL_RAN_OUT = -12, //! Keypool ran out, call keypoolrefill first
72-
RPC_WALLET_UNLOCK_NEEDED = -13, //! Enter the wallet passphrase with walletpassphrase first
73-
RPC_WALLET_PASSPHRASE_INCORRECT = -14, //! The wallet passphrase entered was incorrect
74-
RPC_WALLET_WRONG_ENC_STATE = -15, //! Command given in wrong wallet encryption state (encrypting an encrypted wallet etc.)
75-
RPC_WALLET_ENCRYPTION_FAILED = -16, //! Failed to encrypt the wallet
76-
RPC_WALLET_ALREADY_UNLOCKED = -17, //! Wallet is already unlocked
68+
RPC_WALLET_ERROR = -4, //!< Unspecified problem with wallet (key not found etc.)
69+
RPC_WALLET_INSUFFICIENT_FUNDS = -6, //!< Not enough funds in wallet or account
70+
RPC_WALLET_INVALID_ACCOUNT_NAME = -11, //!< Invalid account name
71+
RPC_WALLET_KEYPOOL_RAN_OUT = -12, //!< Keypool ran out, call keypoolrefill first
72+
RPC_WALLET_UNLOCK_NEEDED = -13, //!< Enter the wallet passphrase with walletpassphrase first
73+
RPC_WALLET_PASSPHRASE_INCORRECT = -14, //!< The wallet passphrase entered was incorrect
74+
RPC_WALLET_WRONG_ENC_STATE = -15, //!< Command given in wrong wallet encryption state (encrypting an encrypted wallet etc.)
75+
RPC_WALLET_ENCRYPTION_FAILED = -16, //!< Failed to encrypt the wallet
76+
RPC_WALLET_ALREADY_UNLOCKED = -17, //!< Wallet is already unlocked
7777
};
7878

7979
std::string JSONRPCRequest(const std::string& strMethod, const UniValue& params, const UniValue& id);

‎src/script/sign.h‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ class MutableTransactionSignatureCreator : public TransactionSignatureCreator {
5151
MutableTransactionSignatureCreator(const CKeyStore* keystoreIn, const CMutableTransaction* txToIn, unsigned int nInIn, const CAmount& amount, int nHashTypeIn) : TransactionSignatureCreator(keystoreIn, &tx, nInIn, amount, nHashTypeIn), tx(*txToIn) {}
5252
};
5353

54-
/** A signature creator that just produces 72-byte empty signatyres. */
54+
/** A signature creator that just produces 72-byte empty signatures. */
5555
class DummySignatureCreator : public BaseSignatureCreator {
5656
public:
5757
DummySignatureCreator(const CKeyStore* keystoreIn) : BaseSignatureCreator(keystoreIn) {}

‎src/zmq/zmqpublishnotifier.h‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ class CBlockIndex;
1212
class CZMQAbstractPublishNotifier : public CZMQAbstractNotifier
1313
{
1414
private:
15-
uint32_t nSequence; //! upcounting per message sequence number
15+
uint32_t nSequence; //!< upcounting per message sequence number
1616

1717
public:
1818

0 commit comments

Comments
 (0)