Add missing, and update existing, documentation on the RSA classes #3660
Conversation
carlossanlop
added
🏁 Release: .NET Core 2.x
| <returns>To be added.</returns> | ||
| <remarks>To be added.</remarks> | ||
| <param name="hashAlgorithm">The hash algorithm used to create the hash value of the data.</param> | ||
| <param name="padding">The padding.</param> |
There was a problem hiding this comment.
This parameter could use a better description.
| <returns>To be added.</returns> | ||
| <param name="hash">The hash value of the data to be signed.</param> | ||
| <param name="hashAlgorithm">The hash algorithm used to create the hash value of the data.</param> | ||
| <param name="padding">The padding.</param> |
There was a problem hiding this comment.
This parameter could use a better description.
| <param name="hash">The hash value of the signed data.</param> | ||
| <param name="signature">The signature data to be verified.</param> | ||
| <param name="hashAlgorithm">The hash algorithm used to create the hash value.</param> | ||
| <param name="padding">The padding mode.</param> |
There was a problem hiding this comment.
This parameter has one extra word, but I think it could also be described better.
There was a problem hiding this comment.
Same suggestion applies to the rest of the padding params.
There was a problem hiding this comment.
The "padding" parameter descriptions are the ones that are already present on the documented overloads and variants (e.g. https://docs.microsoft.com/en-us/dotnet/api/system.security.cryptography.rsa.signdata?view=netframework-4.8).
They can be long winded, such as "The padding mode to use for the {encryption|decryption|signing|verification} process.", but there's really nothing else that I can think of to say about them. I'm open to suggestions, but absent a specific suggestion I'm going to leave them as-is.
|
Looks like there were some bad cref/xrefs, I'll get them after lunch (assuming no one does it before then). |
|
@bartonjs This now has merge conflicts. Can you resolve those? |
# Conflicts: # xml/System.Security.Cryptography/RSACng.xml
|
@BillWagner Conflicts resolved, bad crefs/xrefs resolved. |
cc: @carlossanlop