docs: Modernize XML Documentation for Symmetric Infrastructure (Batch 4)#671
Closed
KonradSop wants to merge 2 commits intobcgit:masterfrom
Closed
docs: Modernize XML Documentation for Symmetric Infrastructure (Batch 4)#671KonradSop wants to merge 2 commits intobcgit:masterfrom
KonradSop wants to merge 2 commits intobcgit:masterfrom
Conversation
Systematic modernization of API documentation for symmetric cryptographic modules, including block cipher modes, padding schemes, and parameter wrappers. Achieved 100% XML coverage for modern .NET Spans and performed a comprehensive informativeness audit.
peterdettman
requested changes
Apr 17, 2026
- Revert parameter rename in ParametersWithIV.Create<TState>: restore original 'parameter' name and TODO[api] comment (breaking API change) - Restore deleted implementation note in BufferedBlockCipher.GetOutputSize - Wrap all XML doc comment lines to 120-character limit across all changed files (BufferedBlockCipher, CfbBlockCipher, X923Padding, ParametersWithRandom) - Add XML documentation to ParametersWithUkm Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Contributor
Author
|
Thanks for the review! I've addressed all three points:
|
3 tasks
Collaborator
|
Thanks for the update. Squashed, rebased, merged. |
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.
Description
Systematic modernization of API documentation for symmetric cryptographic modules.
Replaced legacy Java-style comments with professional C# XML documentation, specifically targeting:
BufferedBlockCipher.SIC/CTR,CFB,OFBincluding allSpanoverloads.PKCS7,ISO7816-4,X9.23with detailed randomness behavior and Span support.ParametersWithIV,ParametersWithSalt,ParametersWithID,ParametersWithRandom,ParametersWithSBox, andParametersWithUKM.Key Accomplishments
<summary>and<returns>.Span<byte>andReadOnlySpan<byte>infrastructure.Verification
Checklist before requesting a review
See also Contributing Guidelines.