diff options
author | MarcoFalke <falke.marco@gmail.com> | 2019-09-10 15:50:16 +0300 |
---|---|---|
committer | MarcoFalke <falke.marco@gmail.com> | 2019-09-10 15:48:23 +0300 |
commit | fa912a8ad5a94cd2bdc149400b1befb346621f03 (patch) | |
tree | 80d492cd096ee565ba8a72207f1ef7c35e20d0b9 /src | |
parent | fa99efd054c57cd6717391f9ae8ce32b06986ff8 (diff) |
doc: move-only ActivateBestChain doxygen comment to header
Diffstat (limited to 'src')
-rw-r--r-- | src/validation.cpp | 11 | ||||
-rw-r--r-- | src/validation.h | 15 |
2 files changed, 14 insertions, 12 deletions
diff --git a/src/validation.cpp b/src/validation.cpp index 57028fa669..8b842553c6 100644 --- a/src/validation.cpp +++ b/src/validation.cpp @@ -2592,17 +2592,6 @@ static void LimitValidationInterfaceQueue() LOCKS_EXCLUDED(cs_main) { } } -/** - * Make the best chain active, in multiple steps. The result is either failure - * or an activated best chain. pblock is either nullptr or a pointer to a block - * that is already loaded (to avoid loading it again from disk). - * - * ActivateBestChain is split into steps (see ActivateBestChainStep) so that - * we avoid holding cs_main for an extended period of time; the length of this - * call may be quite long during reindexing or a substantial reorg. - * - * @returns true unless a system error occurred - */ bool CChainState::ActivateBestChain(CValidationState &state, const CChainParams& chainparams, std::shared_ptr<const CBlock> pblock) { // Note that while we're often called here from ProcessNewBlock, this is // far from a guarantee. Things in the P2P/RPC will often end up calling diff --git a/src/validation.h b/src/validation.h index 3b11096282..06252b6bc8 100644 --- a/src/validation.h +++ b/src/validation.h @@ -669,7 +669,20 @@ public: //! if we pruned. void PruneAndFlush(); - bool ActivateBestChain(CValidationState &state, const CChainParams& chainparams, std::shared_ptr<const CBlock> pblock) LOCKS_EXCLUDED(cs_main); + /** + * Make the best chain active, in multiple steps. The result is either failure + * or an activated best chain. pblock is either nullptr or a pointer to a block + * that is already loaded (to avoid loading it again from disk). + * + * ActivateBestChain is split into steps (see ActivateBestChainStep) so that + * we avoid holding cs_main for an extended period of time; the length of this + * call may be quite long during reindexing or a substantial reorg. + * + * @returns true unless a system error occurred + */ + bool ActivateBestChain(CValidationState& state, + const CChainParams& chainparams, + std::shared_ptr<const CBlock> pblock) LOCKS_EXCLUDED(cs_main); bool AcceptBlock(const std::shared_ptr<const CBlock>& pblock, CValidationState& state, const CChainParams& chainparams, CBlockIndex** ppindex, bool fRequested, const FlatFilePos* dbp, bool* fNewBlock) EXCLUSIVE_LOCKS_REQUIRED(cs_main); |