[Mono.Android] Add XML docs to KeyCharacterMap convenience overloads - #11746
Merged
jonathanpeppers merged 2 commits intoJun 26, 2026
Merged
Conversation
Co-authored-by: jonathanpeppers <840039+jonathanpeppers@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add XML documentation to KeyCharacterMap convenience overloads
[Mono.Android] Add XML docs to KeyCharacterMap convenience overloads
Jun 26, 2026
simonrozsival
approved these changes
Jun 26, 2026
jonathanpeppers
marked this pull request as ready for review
June 26, 2026 13:07
jonathanpeppers
deleted the
copilot/fix-finder-add-xml-documentation-again
branch
June 26, 2026 13:07
Contributor
There was a problem hiding this comment.
Pull request overview
Adds missing XML documentation to the two public convenience overloads on Android.Views.KeyCharacterMap that accept metaState as an int, aligning them with existing documentation patterns used elsewhere in Mono.Android (notably Android.Util.Log).
Changes:
- Added
<summary>,<param>, and<returns>docs forGet (Keycode, int)andGetMatch (Keycode, char[], int). - Added
MetaKeyStatesreferences in parameter docs to clarify the meaning of the integermetaState. - Added
<seealso href="...">links to the corresponding Android reference documentation pages.
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 two public convenience overloads in
src/Mono.Android/Android.Views/KeyCharacterMap.csship inMono.Android.dllwithout XML documentation. Both are managed overloads that take the meta-key state as anintand delegate to the strongly-typedMetaKeyStatesoverloads, so they have no base/interface docs to inherit.Changes
///XML documentation (<summary>,<param>,<returns>,<seealso href>) toGet (Keycode, int)andGetMatch (Keycode, char[], int).Android.Util/Log.cs;<see cref="MetaKeyStates"/>resolves unqualified since it shares theAndroid.Viewsnamespace.usingdirectives, or#nullable enabletouched.