Skip to content

[Mono.Android] Add XML docs to KeyCharacterMap convenience overloads - #11746

Merged
jonathanpeppers merged 2 commits into
mainfrom
copilot/fix-finder-add-xml-documentation-again
Jun 26, 2026
Merged

[Mono.Android] Add XML docs to KeyCharacterMap convenience overloads#11746
jonathanpeppers merged 2 commits into
mainfrom
copilot/fix-finder-add-xml-documentation-again

Conversation

Copilot AI commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

The two public convenience overloads in src/Mono.Android/Android.Views/KeyCharacterMap.cs ship in Mono.Android.dll without XML documentation. Both are managed overloads that take the meta-key state as an int and delegate to the strongly-typed MetaKeyStates overloads, so they have no base/interface docs to inherit.

Changes

  • Added /// XML documentation (<summary>, <param>, <returns>, <seealso href>) to Get (Keycode, int) and GetMatch (Keycode, char[], int).
  • Followed the existing doc style from Android.Util/Log.cs; <see cref="MetaKeyStates"/> resolves unqualified since it shares the Android.Views namespace.
  • Docs-only: no signatures, logic, using directives, or #nullable enable touched.
/// <summary>
/// Gets the Unicode character generated by the specified key and meta key state combination.
/// </summary>
/// <param name="keyCode">The key code.</param>
/// <param name="metaState">A combination of <see cref="MetaKeyStates"/> values, expressed as an integer.</param>
/// <returns>The Unicode character (code point) produced by the key, or <c>0</c> if the key does not produce a character.</returns>
/// <seealso href="https://developer.android.com/reference/android/view/KeyCharacterMap#get(int,%20int)">Android documentation for <c>android.view.KeyCharacterMap.get</c></seealso>
public int Get (Keycode keyCode, int metaState)

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
Copilot AI requested a review from jonathanpeppers June 26, 2026 03:03
@jonathanpeppers
jonathanpeppers marked this pull request as ready for review June 26, 2026 13:07
Copilot AI review requested due to automatic review settings June 26, 2026 13:07
@jonathanpeppers
jonathanpeppers merged commit 9007857 into main Jun 26, 2026
41 checks passed
@jonathanpeppers
jonathanpeppers deleted the copilot/fix-finder-add-xml-documentation-again branch June 26, 2026 13:07

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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 for Get (Keycode, int) and GetMatch (Keycode, char[], int).
  • Added MetaKeyStates references in parameter docs to clarify the meaning of the integer metaState.
  • Added <seealso href="..."> links to the corresponding Android reference documentation pages.

@github-actions github-actions Bot locked and limited conversation to collaborators Jul 27, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants