Remove .NET Framework remarks (System.Security.Cryptography)#12655
Merged
gewarren merged 7 commits intoMay 29, 2026
Conversation
Contributor
|
Tagging subscribers to this area: @dotnet/area-system-security, @vcsjones |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the .NET API reference XML docs in System.Security.Cryptography* to remove .NET Framework-specific remarks, exceptions, and usage notes now that .NET Framework API reference docs have moved to a separate repo.
Changes:
- Removed or rewrote remarks that referenced .NET Framework-only features and behaviors (CAS, app.config, AppDomains, framework-version notes).
- Normalized several exception descriptions to remove framework qualifiers (for example, “In all cases.”).
- Cleaned up and reflowed various remarks blocks and IMPORTANT/NOTE callouts.
Reviewed changes
Copilot reviewed 41 out of 41 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| xml/System.Security.Cryptography/SymmetricAlgorithm.xml | Rewords remarks to drop .NET Framework phrasing and adjusts Create() docs. |
| xml/System.Security.Cryptography/SHA256.xml | Removes .NET Framework-specific return/exception details for Create overloads. |
| xml/System.Security.Cryptography/RSACryptoServiceProvider.xml | Removes AppDomain/version-specific wording from UseMachineKeyStore remarks. |
| xml/System.Security.Cryptography/RSACng.xml | Removes .NET Framework version-specific exception behavior from VerifyHash docs. |
| xml/System.Security.Cryptography/RSA.xml | Removes .NET Framework version notes and normalizes exception text. |
| xml/System.Security.Cryptography/RijndaelManaged.xml | Removes .NET Framework vs .NET Core block-size distinctions, simplifying to modern .NET behavior. |
| xml/System.Security.Cryptography/ProtectedData.xml | Rewords Windows-only support notes and adds/updates PlatformNotSupportedException text. |
| xml/System.Security.Cryptography/Oid.xml | Updates property summaries to reflect init-only narrative (but signatures still show settable). |
| xml/System.Security.Cryptography/KeyedHashAlgorithm.xml | Removes .NET Framework versioning notes; normalizes PNSE text. |
| xml/System.Security.Cryptography/HMACSHA512.xml | Removes legacy .NET Framework 2.0 SP notes and replaces with placeholder remarks. |
| xml/System.Security.Cryptography/HMACSHA384.xml | Removes legacy .NET Framework 2.0 SP notes and replaces with placeholder remarks. |
| xml/System.Security.Cryptography/HMAC.xml | Removes config-system mention and normalizes PNSE text. |
| xml/System.Security.Cryptography/HashAlgorithm.xml | Removes obsoletion/version notes and normalizes PNSE text. |
| xml/System.Security.Cryptography/FromBase64Transform.xml | Converts markdown remarks to XML paragraphs for CanTransformMultipleBlocks. |
| xml/System.Security.Cryptography/ECDsa.xml | Rewords remarks/parameter guidance to remove .NET Framework mention. |
| xml/System.Security.Cryptography/ECDiffieHellmanPublicKey.xml | Rewords PlatformNotSupportedException descriptions to remove framework qualifiers. |
| xml/System.Security.Cryptography/ECDiffieHellmanCngPublicKey.xml | Normalizes whitespace and replaces some .NET Framework-specific remarks/exceptions. |
| xml/System.Security.Cryptography/ECDiffieHellmanCng.xml | Removes argument/format exception documentation and normalizes PNSE text. |
| xml/System.Security.Cryptography/ECDiffieHellman.xml | Rewords remarks to remove .NET Framework mention and reformats lists. |
| xml/System.Security.Cryptography/DSACryptoServiceProvider.xml | Removes AppDomain/version-specific wording from UseMachineKeyStore remarks. |
| xml/System.Security.Cryptography/CryptoStream.xml | Removes .NET Framework comparison from partial-read IMPORTANT notes and async remarks. |
| xml/System.Security.Cryptography/CryptoConfig.xml | Removes .NET Framework config file references and partial-trust/CAS-related remarks. |
| xml/System.Security.Cryptography/CngProvider.xml | Removes “service packs / .NET Framework releases” wording from remarks. |
| xml/System.Security.Cryptography/CngKeyBlobFormat.xml | Removes “service packs / .NET Framework releases” wording from remarks. |
| xml/System.Security.Cryptography/CngAlgorithmGroup.xml | Removes “service packs / .NET Framework releases” wording from remarks. |
| xml/System.Security.Cryptography/CngAlgorithm.xml | Removes “service packs / .NET Framework releases” wording from remarks. |
| xml/System.Security.Cryptography/AsymmetricAlgorithm.xml | Removes config-system mention and normalizes PNSE text. |
| xml/System.Security.Cryptography/AsnEncodedData.xml | Rewords remarks to remove .NET Framework mention and trims extra whitespace. |
| xml/System.Security.Cryptography.Xml/SignedXml.xml | Removes .NET Framework version-specific certificate-verification notes. |
| xml/System.Security.Cryptography.Xml/EncryptedXml.xml | Rewords remarks to remove .NET Framework mention and trims redundant constructor remarks. |
| xml/System.Security.Cryptography.X509Certificates/X509Store.xml | Removes .NET Framework version-based IDisposable guidance and replaces dispose remarks. |
| xml/System.Security.Cryptography.X509Certificates/X509ExtensionCollection.xml | Rewords SyncRoot remarks to remove .NET Framework phrasing. |
| xml/System.Security.Cryptography.X509Certificates/X509Extension.xml | Rewords list intro to remove .NET Framework mention and reformats list. |
| xml/System.Security.Cryptography.X509Certificates/X509ChainStatusFlags.xml | Removes .NET Framework-introduced version note for certain flags. |
| xml/System.Security.Cryptography.X509Certificates/X509Chain.xml | Removes .NET Framework version-based IDisposable guidance and replaces dispose remarks. |
| xml/System.Security.Cryptography.X509Certificates/X509Certificate2.xml | Removes .NET Framework-only permission/version notes and normalizes PNSE text. |
| xml/System.Security.Cryptography.X509Certificates/X509Certificate.xml | Removes .NET Framework version-based IDisposable guidance and replaces various remarks/exceptions. |
| xml/System.Security.Cryptography.Pkcs/SignerInfo.xml | Removes CAS permission notes and normalizes countersignature remarks spacing. |
| xml/System.Security.Cryptography.Pkcs/SignedCms.xml | Removes CAS permission notes; normalizes silent parameter doc and exception text. |
| xml/System.Security.Cryptography.Pkcs/EnvelopedCms.xml | Removes .NET Framework vs .NET Core algorithm-default notes and CAS permission remarks. |
| xml/System.Security.Cryptography.Pkcs/CmsSigner.xml | Removes .NET Framework-only support note and normalizes PNSE text. |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
bartonjs
reviewed
May 27, 2026
bartonjs
reviewed
May 27, 2026
bartonjs
reviewed
May 27, 2026
…gewarren/dotnet-api-docs into fw-remarks-system-security-cryptography
Clarified that the property is *init only* in .NET 5 and later versions.
bartonjs
reviewed
May 28, 2026
bartonjs
approved these changes
May 28, 2026
Member
bartonjs
left a comment
There was a problem hiding this comment.
Other than the potential followup to normalize returns statements for always-throw methods, LGTM.
…gewarren/dotnet-api-docs into fw-remarks-system-security-cryptography
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.
.NET Framework API ref has moved to its own repo (https://github.com/dotnet/dotnetfw-api-docs), so we can clean up .NET Framework remarks, exceptions, and code examples out of this repo. Contributes to #12513.
Removes remarks and examples related to:
Also removes all remarks from obsolete APIs.
Hide whitespace changes