Add XML documentation to Android.Security.KeyChain public methods - #11364
Merged
jonathanpeppers merged 2 commits intoMay 15, 2026
Conversation
6 tasks
Agent-Logs-Url: https://github.com/dotnet/android/sessions/aaa417d4-fe5b-4b78-b07a-462fda67df43 Co-authored-by: jonathanpeppers <840039+jonathanpeppers@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add XML documentation to public methods in Android.Security.KeyChain
Add XML documentation to May 14, 2026
Android.Security.KeyChain public methods
jonathanpeppers
marked this pull request as ready for review
May 14, 2026 22:54
Contributor
There was a problem hiding this comment.
Pull request overview
Adds XML documentation comments to the public methods of the Android.Security.KeyChain partial class. These methods are .NET-specific helpers bridging Android's KeyChain to X509Certificate2, and previously lacked any doc comments.
Changes:
- Documents
GetX509Certificate2WithPrivateKeywith summary, params, returns, and remarks. - Documents both
ChoosePrivateKeyAliasAsyncoverloads. - Documents both
ChooseX509Certificate2WithPrivateKeyAsyncoverloads.
jonathanpeppers
approved these changes
May 15, 2026
jonathanpeppers
deleted the
copilot/add-xml-documentation-keychain-methods
branch
May 15, 2026 13:25
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
The 5 public methods in the
KeyChainpartial class are .NET-specific convenience methods bridging Android's KeyChain API toX509Certificate2, but had no XML documentation.Added
<summary>,<param>,<returns>, and<remarks>to all public methods:GetX509Certificate2WithPrivateKey— documents theGetPrivateKey+GetCertificateChaincombinationChoosePrivateKeyAliasAsync(both overloads) — documents the system certificate selection UI and async callback wrapperChooseX509Certificate2WithPrivateKeyAsync(both overloads) — documents the combined alias-selection + certificate-retrieval workflowCross-references use
<see cref="..."/>to the underlying Android APIs and related .NET types likeHttpClientHandler.ClientCertificates. API 23+ requirements noted in<remarks>where[SupportedOSPlatform]is present.Documentation only — no code changes.