Document JNI reference metadata - #559
Open
jonathanpeppers wants to merge 1 commit into
Open
Conversation
Refs #193 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
jonathanpeppers
requested review from
dalexsoto
and
a lite review from Copilot
August 15, 2026 14:40
jonathanpeppers
enabled auto-merge (squash)
August 15, 2026 14:40
There was a problem hiding this comment.
Pull request overview
This PR updates the Java.Interop XML reference documentation to replace “To be added.” placeholders with concrete JNI reference information, aligning the docs with the Oracle JNI specification and improving the quality of generated API docs.
Changes:
- Added summary + reference links to the relevant Oracle JNI spec sections for
GetVersion,GetObjectRefType, andReleasePrimitiveTypeArrayElements. - Documented enum member meanings for JNI versions, object reference kinds, and array-elements release modes.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/xml/Java.Interop/JniVersion.xml | Documents the meaning of JniVersion and its enum values, including a link to the JNI GetVersion spec. |
| docs/xml/Java.Interop/JniReleaseArrayElementsMode.xml | Documents how array element buffers are released (copy/free behavior), with a link to the relevant JNI spec. |
| docs/xml/Java.Interop/JniObjectReferenceType.xml | Documents JNI object reference kinds (local/global/weak), with a link to the GetObjectRefType spec. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Member
Author
|
@dalexsoto review |
1 similar comment
Member
Author
|
@dalexsoto review |
dalexsoto
requested changes
Aug 16, 2026
dalexsoto
left a comment
Member
There was a problem hiding this comment.
Two JNI contract issues remain:
JniReleaseArrayElementsModedescribes copy/free effects unconditionally, but JNI says the mode has no effect when the pointer is not a copy;Abortcannot roll back direct/pinned mutations, andCommitstill requires a final release.- The new JNI specification links use nonexistent, case-sensitive fragments, so they do not navigate to
GetObjectRefType, release-mode, orGetVersionsections.
Please correct the mode semantics and exact fragments in JniReleaseArrayElementsMode.xml and the related reference files.
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Documents JNI reference kinds, array-element release behavior, and supported JNI versions.
Refs #193
Sources
Validation
git diff --check.