-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Add missing documentation for DSA types #3498
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
cc: @carlossanlop |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for making the change, @bartonjs. I left a couple of questions and a couple of nit suggestions for you to consider.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great @bartonjs. Left a few comments for you to consider. (some are cosmetic to avoid the CI tool to touch these files in the next run. Others seem cosmetic but they look broken if not fixed such as the indented -or-).
Co-Authored-By: Maira Wenzel <[email protected]> Co-Authored-By: Carlos Sanchez Lopez <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, no build warnings. Pending to answer the seealso vs altmember question, but I think it looks good to merge.
@mairaw I'll merge. If we have to change the |
There are some warnings here. Please don't merge yet. |
I'll take a look at them soon, @mairaw |
<paramref name="handle" /> is <see cref="F:System.IntPtr.Zero"/>.</exception> | ||
<exception cref="T:System.Security.Cryptography.CryptographicException"> | ||
<paramref name="handle"/> is not a valid <c>DSA*</c>.</exception> | ||
<altmember cref="P:System.Security.Cryptography.SafeEvpPKeyValue.OpenSslVersion" /> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
build warning due to malformed DocId.
The SafeEvpPKeyValue class should've been SafeEvpPKeyHandle:
<altmember cref="P:System.Security.Cryptography.SafeEvpPKeyValue.OpenSslVersion" /> | |
<altmember cref="P:System.Security.Cryptography.SafeEvpPKeyHandle.OpenSslVersion" /> |
</exception> | ||
<exception cref="T:System.Security.Cryptography.CryptographicException"> | ||
<paramref name="parameters"/> does not represent a valid DSA key parameter set.</exception> | ||
<altmember cref="M:System.Security.Cryptography.DSA.Create(System.Security.Cryptography.DSA.Create(System.Security.Cryptography.DSAParameters)" /> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Malformed DocId. There's a Create call inside the Create call. I removed all the similar instances in this file.
No description provided.