Document SummaryConfig Class#4853
Merged
Merged
Conversation
bska
added
the
manual:irrelevant
Member
Author
|
jenkins build this please |
akva2
approved these changes
Dec 5, 2025
bska
force-pushed
the
document-smrycfg-api
branch
from
48204ef to
4a3d951
Compare
Member
Author
Good catch. That one was actually repeated elsewhere as well 🤦 I've pushed an update to address that and, additionally, document the (poorly named) |
Member
Author
|
jenkins build this please |
This commit adds Doxygen-style documentation to the SummaryConfig and SummaryConfigNode classes and ancillary functions (comparison operators and keyword category/type parsers). While here, also make the begin/end/size member functions inline in the SummaryConfig class since they're entirely trivial and remove the (long) unused member function SummaryConfig::wbp_wells().
bska
force-pushed
the
document-smrycfg-api
branch
from
4a3d951 to
3a320d3
Compare
Member
Author
|
jenkins build this please |
Member
Author
|
PR approved and build check is green. I'll merge into master. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
This PR adds Doxygen-style documentation to the
SummaryConfigandSummaryConfigNodeclasses and ancillary functions (comparison operators and keyword category/type parsers).While here, also make the begin/end/size member functions inline in the
SummaryConfigclass since they're entirely trivial and remove the (long) unused member functionSummaryConfig::wbp_wells().