Skip to content

Add XML documentation to JValue struct#11354

Merged
jonathanpeppers merged 2 commits into
mainfrom
copilot/add-xml-documentation-jvalue
May 15, 2026
Merged

Add XML documentation to JValue struct#11354
jonathanpeppers merged 2 commits into
mainfrom
copilot/add-xml-documentation-jvalue

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 14, 2026

JValue is a fundamental JNI interop type with zero documentation on any public member. Adds /// XML doc comments to the struct and all 10 public members.

  • Struct-level <summary> and <remarks> with link to JNI Type Specification
  • Each constructor documents its corresponding JNI type (jboolean, jbyte, jchar, jshort, jint, jlong, jfloat, jdouble, jobject)
  • IJavaObject constructor documents null-handling (extracts Handle, passes IntPtr.Zero for null)
  • JValue.Zero field documented

No logic changes.

Agent-Logs-Url: https://github.com/dotnet/android/sessions/a7333575-ebda-4bf1-95a4-d10a0cae606e

Co-authored-by: jonathanpeppers <840039+jonathanpeppers@users.noreply.github.com>
Copilot AI changed the title [WIP] Add XML documentation to JValue struct Add XML documentation to JValue struct May 14, 2026
Copilot AI requested a review from jonathanpeppers May 14, 2026 21:46
@jonathanpeppers jonathanpeppers marked this pull request as ready for review May 14, 2026 21:53
Copilot AI review requested due to automatic review settings May 14, 2026 21:53
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 to the public Android.Runtime.JValue struct to make the JNI interop surface discoverable in IDE IntelliSense and generated API docs.

Changes:

  • Added struct-level <summary>/<remarks> describing jvalue usage and linking to the JNI type specification.
  • Added XML docs for JValue.Zero and all JValue constructors, including the IJavaObject null-handling behavior.

@jonathanpeppers jonathanpeppers merged commit a9d7aad into main May 15, 2026
6 of 7 checks passed
@jonathanpeppers jonathanpeppers deleted the copilot/add-xml-documentation-jvalue branch May 15, 2026 13:20
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 JValue struct

3 participants