Skip to content

Document Java runtime namespace - #570

Open
jonathanpeppers wants to merge 2 commits into
mainfrom
jonathanpeppers-document-java-runtimes
Open

Document Java runtime namespace#570
jonathanpeppers wants to merge 2 commits into
mainfrom
jonathanpeppers-document-java-runtimes

Conversation

@jonathanpeppers

@jonathanpeppers jonathanpeppers commented Aug 15, 2026

Copy link
Copy Markdown
Member

Summary

  • Document Java.Lang.Runtimes and its ObjectMethods and SwitchBootstraps APIs.
  • Add source-backed descriptions for record-object and switch bootstrap methods, including their parameters and results.
  • Document managed JNI binding members and remove every scoped XML documentation placeholder.

Sources

Validation

  • Parsed docs/xml/ns-Java.Lang.Runtimes.xml, docs/xml/Java.Lang.Runtimes/ObjectMethods.xml, and docs/xml/Java.Lang.Runtimes/SwitchBootstraps.xml with [xml](Get-Content -Raw ...).
  • Confirmed CRLF line endings in all changed XML files.
  • rg -n -i --glob 'Java.Lang.Runtimes/**' --glob 'ns-Java.Lang.Runtimes.xml' 'to be added' docs/xml (0 matches)
  • git diff --check

Closes #185

Refs #185

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the namespace-level XML documentation for Java.Lang.Runtimes, aiming to replace placeholder text with meaningful docs for the namespace entry point in the generated API docs.

Changes:

  • Replaced the To be added. placeholder summary/remarks in ns-Java.Lang.Runtimes.xml with real documentation text.
  • Added a short <remarks> section referencing a runtime-related type.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread docs/xml/ns-Java.Lang.Runtimes.xml Outdated
Comment thread docs/xml/ns-Java.Lang.Runtimes.xml Outdated
Refs #185

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@jonathanpeppers

Copy link
Copy Markdown
Member Author

Addressed the review by correcting the namespace scope and documenting ObjectMethods and SwitchBootstraps with Android reference links. The updated validation confirms zero scoped To be added placeholders.

@jonathanpeppers
jonathanpeppers requested review from dalexsoto and removed request for dalexsoto August 15, 2026 16:53
@jonathanpeppers

Copy link
Copy Markdown
Member Author

@dalexsoto review

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.

Add XML documentation for Java.Lang.Runtimes

2 participants