Fix CompareRunPlanData Doxygen to reflect std::optional semantics#127
Merged
rrivera747 merged 2 commits intorrivera/betterCFORunPlanPrintoutCommentsfrom Mar 9, 2026
Merged
Conversation
… add andMasks/orMasks param docs Co-authored-by: rrivera747 <[email protected]>
Copilot
AI
changed the title
[WIP] WIP to address feedback on marker index for opcode printouts
Fix CompareRunPlanData Doxygen to reflect std::optional semantics
Mar 9, 2026
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
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.
The Doxygen for
CompareRunPlanDatastill described themismatchesparameter using raw-pointer terminology ("nullptr") after the signature was refactored to usestd::optional/std::nullopt. TheandMasksandorMasksoutput parameters were also undocumented.Changes
mismatches: replaced "nullptr" withstd::nullopt; clarifies that passingstd::nullopt(default) throws on first mismatch rather than collectingandMasks/orMasks: added@paramentries explaining each collects 48-bit mask values fromAND_MODE_BITS/OR_MODE_BITSinstructions respectively, and thatstd::nulloptskips collectioninputData/runPlanBaseAddress: added missing@paramdescriptions💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.