Refactor XML documentation – part 1 #901
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
koschke
approved these changes
Dec 20, 2025
Collaborator
koschke
left a comment
koschke
left a comment
There was a problem hiding this comment.
I inspected some files and, in addition, I compiled everything.
Looks good. No problem found.
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 PR applies the first part of larger refactoring effort to standardize and improve XML documentation across the project. All changes in this commit are focused on
<param>,<returns>, and<exception>tags.The adjustments were made in accordance with our coding guidelines to ensure:
Proper capitalization at the beginning of these tags.
Correct placement of periods at the end of sentences.
Consistent and meaningful and descriptions.
Inline tags (, ) are preserved correctly.
At several locations, documentation was added where it was previously missing or empty (e.g., or tags without description).
This is the first part of the documentation refactoring. Upcoming PRs will focus on:
Replacing keywords consistently across documentation.
Identifying and maybe filling in missing XML documentation in other sections.