Skip to content

Document Pkcs12SafeContents #2923

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Aug 5, 2019
Merged

Document Pkcs12SafeContents #2923

merged 3 commits into from
Aug 5, 2019

Conversation

bartonjs
Copy link
Member

@bartonjs bartonjs commented Aug 3, 2019

bartonjs
bartonjs commented Aug 3, 2019
View reviewed changes
Copy link
Member Author

@bartonjs bartonjs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correcting bad namespaces.

@rpetrusha rpetrusha added this to the August 2019 milestone Aug 5, 2019
rpetrusha
rpetrusha suggested changes Aug 5, 2019
View reviewed changes
Copy link

@rpetrusha rpetrusha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good, @bartonjs. I've left a couple of comments and suggestions.

xml/System.Security.Cryptography.Pkcs/Pkcs12SafeContents.xml Outdated
@@ -163,9 +194,12 @@
<Docs>
<param name="secretType">To be added.</param>
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you document these two parameters?

xml/System.Security.Cryptography.Pkcs/Pkcs12SafeContents.xml
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">The <paramref name="secretType"/> parameter is <see langword="null"/>.</exception>
<exception cref="T:System.InvalidOperationException">This instance is read-only.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The <paramref name="secretValue"/> parameter does not represent a single ASN.1 BER-encoded value.</exception>
</Docs>
</Member>
<Member MemberName="AddShroudedKey">
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You've done a really good job of disambiguating the method overload summaries.

bartonjs
bartonjs commented Aug 5, 2019
View reviewed changes
Copy link
Member Author

@bartonjs bartonjs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added the missing parameter documentation via suggestions.

@carlossanlop carlossanlop added 🏁 Release: .NET Core 3.0 :checkered_flag: Release: .NET Core 3.0 new-content Indicates PRs that contain new articles labels Aug 5, 2019
@rpetrusha
Copy link

The build was successful, so I'll merge this now, @bartonjs.

@rpetrusha rpetrusha merged commit b81aad0 into dotnet:master Aug 5, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
1 more reviewer

@rpetrusha rpetrusha rpetrusha approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees

@bartonjs bartonjs

Labels
🏁 Release: .NET Core 3.0 :checkered_flag: Release: .NET Core 3.0 new-content Indicates PRs that contain new articles
Projects
None yet
Milestone
August 2019
Development

Successfully merging this pull request may close these issues.
3 participants
@bartonjs @rpetrusha @carlossanlop