API: constants, annotate member vars, relax API pattern, remove junk #45
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
- This adds support for "Constant." in an API description to mark a constant, but also auto-detects constants so that it only needs to be explicit in weird/complex cases. - Fixes a couple instances where member variables were not properly marked as such. - Relaxes the regex for matching an operator, so that things like `base/ConfigBase::DictFieldProxy::operator=(std::span<const unsigned char>)` should be accepted now. - This also removes a bunch of junk around example JSON input/outputs and API fetching that was a relic of this script being originally used for storage server RPC documentation.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This adds support for "Constant." in an API description to mark a constant, but also auto-detects constants so that it only needs to be explicit in weird/complex cases.
Fixes a couple instances where member variables were not properly marked as such.
Relaxes the regex for matching an operator, so that things like
base/ConfigBase::DictFieldProxy::operator=(std::span<const unsigned char>)should be accepted now.This also removes a bunch of junk around example JSON input/outputs and API fetching that was a relic of this script being originally used for storage server RPC documentation.
(Closes #44 )