Potential fix for code scanning alert no. 72: Missing a summary in documentation comment#163
Merged
arvindshmicrosoft merged 1 commit intomainfrom Mar 31, 2026
Merged
Conversation
…cumentation comment Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
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
1 participant
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.
Potential fix for https://github.com/microsoft/SQLCallStackResolver/security/code-scanning/72
In general, to fix this problem you should ensure that any
///documentation comment associated with a member includes a<summary>element that briefly describes the purpose of that member. If there is already descriptive text, it should be wrapped inside<summary>...</summary>.For this specific case in
Engine/StackResolver.cs, update the comment directly aboveExtractFromXELAsyncto be a valid XML documentation comment by adding a<summary>element and placing the existing sentence inside it. No imports or additional methods are needed, and no behavior ofExtractFromXELAsyncchanges; only its documentation comment is updated. The change is limited to the region around line 37 where the method is declared.Suggested fixes powered by Copilot Autofix. Review carefully before merging.