Skip to content

Add XML documentation to Android.Security.KeyChain public methods#11364

Open
Copilot wants to merge 2 commits into
mainfrom
copilot/add-xml-documentation-keychain-methods
Open

Add XML documentation to Android.Security.KeyChain public methods#11364
Copilot wants to merge 2 commits into
mainfrom
copilot/add-xml-documentation-keychain-methods

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 14, 2026

The 5 public methods in the KeyChain partial class are .NET-specific convenience methods bridging Android's KeyChain API to X509Certificate2, but had no XML documentation.

Added <summary>, <param>, <returns>, and <remarks> to all public methods:

  • GetX509Certificate2WithPrivateKey — documents the GetPrivateKey + GetCertificateChain combination
  • ChoosePrivateKeyAliasAsync (both overloads) — documents the system certificate selection UI and async callback wrapper
  • ChooseX509Certificate2WithPrivateKeyAsync (both overloads) — documents the combined alias-selection + certificate-retrieval workflow

Cross-references use <see cref="..."/> to the underlying Android APIs and related .NET types like HttpClientHandler.ClientCertificates. API 23+ requirements noted in <remarks> where [SupportedOSPlatform] is present.

Documentation only — no code changes.

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 Android.Security.KeyChain public methods May 14, 2026
Copilot AI requested a review from jonathanpeppers May 14, 2026 22:37
@jonathanpeppers jonathanpeppers marked this pull request as ready for review May 14, 2026 22:54
Copilot AI review requested due to automatic review settings May 14, 2026 22:54
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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 GetX509Certificate2WithPrivateKey with summary, params, returns, and remarks.
  • Documents both ChoosePrivateKeyAliasAsync overloads.
  • Documents both ChooseX509Certificate2WithPrivateKeyAsync overloads.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[fix-finder] Add XML documentation to Android.Security.KeyChain public methods

3 participants