[doc] Fix doxygen comments for members
This commit is contained in:
@@ -71,6 +71,12 @@ To describe a member or variable use:
|
||||
int var; //!< Detailed description after the member
|
||||
```
|
||||
|
||||
or
|
||||
```cpp
|
||||
//! Description before the member
|
||||
int var;
|
||||
```
|
||||
|
||||
Also OK:
|
||||
```c++
|
||||
///
|
||||
|
||||
@@ -323,8 +323,8 @@ public:
|
||||
assert(consensus.hashGenesisBlock == uint256S("0x0000724595fb3b9609d441cbfb9577615c292abf07d996d3edabc48de843642d"));
|
||||
assert(genesis.hashMerkleRoot == uint256S("0x12630d16a97f24b287c8c2594dda5fb98c9e6c70fc61d44191931ea2aa08dc90"));
|
||||
|
||||
vFixedSeeds.clear(); //! Regtest mode doesn't have any fixed seeds.
|
||||
vSeeds.clear(); //! Regtest mode doesn't have any DNS seeds.
|
||||
vFixedSeeds.clear(); //!< Regtest mode doesn't have any fixed seeds.
|
||||
vSeeds.clear(); //!< Regtest mode doesn't have any DNS seeds.
|
||||
|
||||
base58Prefixes[PUBKEY_ADDRESS] = std::vector<unsigned char>(1,111);
|
||||
base58Prefixes[SCRIPT_ADDRESS] = std::vector<unsigned char>(1,196);
|
||||
|
||||
14
src/main.h
14
src/main.h
@@ -489,13 +489,13 @@ bool TestBlockValidity(CValidationState& state, const CChainParams& chainparams,
|
||||
class CBlockFileInfo
|
||||
{
|
||||
public:
|
||||
unsigned int nBlocks; //! number of blocks stored in file
|
||||
unsigned int nSize; //! number of used bytes of block file
|
||||
unsigned int nUndoSize; //! number of used bytes in the undo file
|
||||
unsigned int nHeightFirst; //! lowest height of block in file
|
||||
unsigned int nHeightLast; //! highest height of block in file
|
||||
uint64_t nTimeFirst; //! earliest time of block in file
|
||||
uint64_t nTimeLast; //! latest time of block in file
|
||||
unsigned int nBlocks; //!< number of blocks stored in file
|
||||
unsigned int nSize; //!< number of used bytes of block file
|
||||
unsigned int nUndoSize; //!< number of used bytes in the undo file
|
||||
unsigned int nHeightFirst; //!< lowest height of block in file
|
||||
unsigned int nHeightLast; //!< highest height of block in file
|
||||
uint64_t nTimeFirst; //!< earliest time of block in file
|
||||
uint64_t nTimeLast; //!< latest time of block in file
|
||||
|
||||
ADD_SERIALIZE_METHODS;
|
||||
|
||||
|
||||
@@ -265,8 +265,8 @@ public:
|
||||
void Read(CAutoFile& filein);
|
||||
|
||||
private:
|
||||
CFeeRate minTrackedFee; //! Passed to constructor to avoid dependency on main
|
||||
double minTrackedPriority; //! Set to AllowFreeThreshold
|
||||
CFeeRate minTrackedFee; //!< Passed to constructor to avoid dependency on main
|
||||
double minTrackedPriority; //!< Set to AllowFreeThreshold
|
||||
unsigned int nBestSeenHeight;
|
||||
struct TxStatsInfo
|
||||
{
|
||||
|
||||
@@ -18,8 +18,8 @@ using namespace std;
|
||||
class CRPCConvertParam
|
||||
{
|
||||
public:
|
||||
std::string methodName; //! method whose params want conversion
|
||||
int paramIdx; //! 0-based idx of param to convert
|
||||
std::string methodName; //!< method whose params want conversion
|
||||
int paramIdx; //!< 0-based idx of param to convert
|
||||
};
|
||||
|
||||
static const CRPCConvertParam vRPCConvertParams[] =
|
||||
|
||||
@@ -1049,12 +1049,12 @@ namespace {
|
||||
*/
|
||||
class CTransactionSignatureSerializer {
|
||||
private:
|
||||
const CTransaction &txTo; //! reference to the spending transaction (the one being serialized)
|
||||
const CScript &scriptCode; //! output script being consumed
|
||||
const unsigned int nIn; //! input index of txTo being signed
|
||||
const bool fAnyoneCanPay; //! whether the hashtype has the SIGHASH_ANYONECANPAY flag set
|
||||
const bool fHashSingle; //! whether the hashtype is SIGHASH_SINGLE
|
||||
const bool fHashNone; //! whether the hashtype is SIGHASH_NONE
|
||||
const CTransaction& txTo; //!< reference to the spending transaction (the one being serialized)
|
||||
const CScript& scriptCode; //!< output script being consumed
|
||||
const unsigned int nIn; //!< input index of txTo being signed
|
||||
const bool fAnyoneCanPay; //!< whether the hashtype has the SIGHASH_ANYONECANPAY flag set
|
||||
const bool fHashSingle; //!< whether the hashtype is SIGHASH_SINGLE
|
||||
const bool fHashNone; //!< whether the hashtype is SIGHASH_NONE
|
||||
|
||||
public:
|
||||
CTransactionSignatureSerializer(const CTransaction &txToIn, const CScript &scriptCodeIn, unsigned int nInIn, int nHashTypeIn) :
|
||||
|
||||
@@ -27,7 +27,7 @@ public:
|
||||
CScriptID(const uint160& in) : uint160(in) {}
|
||||
};
|
||||
|
||||
static const unsigned int MAX_OP_RETURN_RELAY = 83; //! bytes (+1 for OP_RETURN, +2 for the pushdata opcodes)
|
||||
static const unsigned int MAX_OP_RETURN_RELAY = 83; //!< bytes (+1 for OP_RETURN, +2 for the pushdata opcodes)
|
||||
extern bool fAcceptDatacarrier;
|
||||
extern unsigned nMaxDatacarrierBytes;
|
||||
|
||||
|
||||
@@ -96,9 +96,9 @@ private:
|
||||
// descendants as well. if nCountWithDescendants is 0, treat this entry as
|
||||
// dirty, and nSizeWithDescendants and nModFeesWithDescendants will not be
|
||||
// correct.
|
||||
uint64_t nCountWithDescendants; //! number of descendant transactions
|
||||
uint64_t nSizeWithDescendants; //! ... and size
|
||||
CAmount nModFeesWithDescendants; //! ... and total fees (all including us)
|
||||
uint64_t nCountWithDescendants; //!< number of descendant transactions
|
||||
uint64_t nSizeWithDescendants; //!< ... and size
|
||||
CAmount nModFeesWithDescendants; //!< ... and total fees (all including us)
|
||||
|
||||
// Analogous statistics for ancestor transactions
|
||||
uint64_t nCountWithAncestors;
|
||||
@@ -406,18 +406,18 @@ struct TxMempoolInfo
|
||||
class CTxMemPool
|
||||
{
|
||||
private:
|
||||
uint32_t nCheckFrequency; //! Value n means that n times in 2^32 we check.
|
||||
uint32_t nCheckFrequency; //!< Value n means that n times in 2^32 we check.
|
||||
unsigned int nTransactionsUpdated;
|
||||
CBlockPolicyEstimator* minerPolicyEstimator;
|
||||
|
||||
uint64_t totalTxSize; //! sum of all mempool tx' byte sizes
|
||||
uint64_t cachedInnerUsage; //! sum of dynamic memory usage of all the map elements (NOT the maps themselves)
|
||||
uint64_t totalTxSize; //!< sum of all mempool tx' byte sizes
|
||||
uint64_t cachedInnerUsage; //!< sum of dynamic memory usage of all the map elements (NOT the maps themselves)
|
||||
|
||||
CFeeRate minReasonableRelayFee;
|
||||
|
||||
mutable int64_t lastRollingFeeUpdate;
|
||||
mutable bool blockSinceLastRollingFeeBump;
|
||||
mutable double rollingMinimumFeeRate; //! minimum fee to get into the pool, decreases exponentially
|
||||
mutable double rollingMinimumFeeRate; //!< minimum fee to get into the pool, decreases exponentially
|
||||
|
||||
void trackPackageRemoved(const CFeeRate& rate);
|
||||
|
||||
|
||||
@@ -14,7 +14,7 @@
|
||||
|
||||
using namespace std;
|
||||
|
||||
static int64_t nMockTime = 0; //! For unit testing
|
||||
static int64_t nMockTime = 0; //!< For unit testing
|
||||
|
||||
int64_t GetTime()
|
||||
{
|
||||
|
||||
@@ -235,11 +235,11 @@ public:
|
||||
mapValue_t mapValue;
|
||||
std::vector<std::pair<std::string, std::string> > vOrderForm;
|
||||
unsigned int fTimeReceivedIsTxTime;
|
||||
unsigned int nTimeReceived; //! time received by this node
|
||||
unsigned int nTimeReceived; //!< time received by this node
|
||||
unsigned int nTimeSmart;
|
||||
char fFromMe;
|
||||
std::string strFromAccount;
|
||||
int64_t nOrderPos; //! position in ordered transaction list
|
||||
int64_t nOrderPos; //!< position in ordered transaction list
|
||||
|
||||
// memory only
|
||||
mutable bool fDebitCached;
|
||||
@@ -336,7 +336,7 @@ public:
|
||||
}
|
||||
|
||||
READWRITE(*(CMerkleTx*)this);
|
||||
std::vector<CMerkleTx> vUnused; //! Used to be vtxPrev
|
||||
std::vector<CMerkleTx> vUnused; //!< Used to be vtxPrev
|
||||
READWRITE(vUnused);
|
||||
READWRITE(mapValue);
|
||||
READWRITE(vOrderForm);
|
||||
@@ -477,7 +477,7 @@ public:
|
||||
std::string strOtherAccount;
|
||||
std::string strComment;
|
||||
mapValue_t mapValue;
|
||||
int64_t nOrderPos; //! position in ordered transaction list
|
||||
int64_t nOrderPos; //!< position in ordered transaction list
|
||||
uint64_t nEntryNo;
|
||||
|
||||
CAccountingEntry()
|
||||
|
||||
Reference in New Issue
Block a user