Document EGL lifecycle APIs - #521
Open
jonathanpeppers wants to merge 2 commits into
Open
Conversation
Refs #307 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 01:36
jonathanpeppers
enabled auto-merge (squash)
August 15, 2026 01:36
There was a problem hiding this comment.
Pull request overview
This PR incrementally improves the generated XML documentation for Javax.Microedition.Khronos.Egl.IEGL10 by replacing To be added. placeholders with source-backed descriptions for key EGL lifecycle, current-state query, and error-retrieval members.
Changes:
- Added summaries/returns docs for current-state query members (
EglGetCurrentContext,EglGetCurrentDisplay,EglGetCurrentSurface). - Added lifecycle/error contract docs for
EglGetDisplay,EglInitialize,EglMakeCurrent,EglSwapBuffers,EglTerminate, andEglGetError.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Refs #307 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Member
Author
|
@dalexsoto review |
dalexsoto
requested changes
Aug 15, 2026
dalexsoto
left a comment
dalexsoto
left a comment
Member
There was a problem hiding this comment.
Three Android-specific contract issues remain in docs/xml/Javax.Microedition.Khronos.Egl/IEGL10.xml:
- The
EglGetDisplayparameter text saysnative_displayselects the display, but Android’s JNI implementation ignores this argument and always callseglGetDisplay(EGL_DEFAULT_DISPLAY). Please document the effective Android behavior instead. EglGetCurrentSurfaceaccepts onlyEglReadorEglDraw; every other value throwsIllegalArgumentExceptionbefore EGL is called. Please document that exception rather than leaving the invalid-value behavior implicit.EglInitialize,EglMakeCurrent,EglSwapBuffers, andEglTerminatehave nullable managed parameters, but Android throwsIllegalArgumentExceptionfor null required arguments (and for a non-nullmajor_minorshorter than two elements) instead of returningfalse. Please add the missing exception contracts so callers are not misled by the return-value documentation.
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.
Refs #307
Documents the EGL display lifecycle, current-state queries, and error retrieval contracts for nine IEGL10 members. The remaining namespace placeholders are deliberately outside this narrow source-backed increment.
Sources
Validation