doc: CChainState return values #16757
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
maflcko
force-pushed
the
1909-docValABCS
branch
from
fa8ec77 to
fa0b359
Compare
Contributor
|
The following sections might be updated with supplementary metadata relevant to reviewers and maintainers. ConflictsReviewers, this pull request conflicts with the following ones:
If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first. |
maflcko
force-pushed
the
1909-docValABCS
branch
from
fa0b359 to
fa79e17
Compare
maflcko
changed the title
promag
reviewed
Aug 30, 2019
maflcko
force-pushed
the
1909-docValABCS
branch
from
fa79e17 to
fa99efd
Compare
laanwj
reviewed
Sep 10, 2019
| * | ||
| * @returns true unless a system error occurred | ||
| */ | ||
| bool CChainState::ActivateBestChainStep(CValidationState& state, const CChainParams& chainparams, CBlockIndex* pindexMostWork, const std::shared_ptr<const CBlock>& pblock, bool& fInvalidFound, ConnectTrace& connectTrace) |
Member
There was a problem hiding this comment.
As the method is defined there, shouldn't this documentation be in the .h file? (same for CChainState::ActivateBestChain below)
Member
Author
There was a problem hiding this comment.
ActivateBestChainStep is marked private and was never meant to be exposed in the header. I think it makes sense to keep the documentation close to the function implementation
Member
Author
There was a problem hiding this comment.
Good point for the public method, though. So I fixed this for ABC only
Member
Author
|
Added a commit that can be reviewed with the git diff options |
Member
|
ACK fa912a8 |
laanwj
added a commit
that referenced
this pull request
Sep 16, 2019
fa912a8 doc: move-only ActivateBestChain doxygen comment to header (MarcoFalke) fa99efd doc: ActivateBestChainStep return value (MarcoFalke) Pull request description: It will always return true, unless a system error such as #15305 occurred ACKs for top commit: laanwj: ACK fa912a8 Tree-SHA512: d439da844a467f9705014b946d7d987fb62cb63fe6a325b2fdbbb73a6578fc0ade3f60892044f02face43948204fc4e3c9fa70d108233d4ca8eef27984059689
sidhujag
pushed a commit
to syscoin/syscoin
that referenced
this pull request
Sep 16, 2019
fa912a8 doc: move-only ActivateBestChain doxygen comment to header (MarcoFalke) fa99efd doc: ActivateBestChainStep return value (MarcoFalke) Pull request description: It will always return true, unless a system error such as bitcoin#15305 occurred ACKs for top commit: laanwj: ACK fa912a8 Tree-SHA512: d439da844a467f9705014b946d7d987fb62cb63fe6a325b2fdbbb73a6578fc0ade3f60892044f02face43948204fc4e3c9fa70d108233d4ca8eef27984059689
jasonbcox
pushed a commit
to Bitcoin-ABC/bitcoin-abc
that referenced
this pull request
Oct 16, 2020
Summary:
fa912a8ad5a94cd2bdc149400b1befb346621f03 doc: move-only ActivateBestChain doxygen comment to header (MarcoFalke)
fa99efd054c57cd6717391f9ae8ce32b06986ff8 doc: ActivateBestChainStep return value (MarcoFalke)
Pull request description:
It will always return true, unless a system error such as #15305 occurred
ACKs for top commit:
laanwj:
ACK fa912a8ad5a94cd2bdc149400b1befb346621f03
---
Backport of Core [[bitcoin/bitcoin#16757 | PR16757]]
Test Plan:
read the comments
Reviewers: #bitcoin_abc, deadalnix
Reviewed By: #bitcoin_abc, deadalnix
Differential Revision: https://reviews.bitcoinabc.org/D7958
kwvg
added a commit
to kwvg/dash
that referenced
this pull request
Oct 22, 2021
pravblockc
pushed a commit
to pravblockc/dash
that referenced
this pull request
Nov 18, 2021
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It will always return true, unless a system error such as #15305 occurred