Skip to content

Document Java logging binding members - #576

Open
jonathanpeppers wants to merge 3 commits into
mainfrom
jonathanpeppers-document-java-logging-apis
Open

Document Java logging binding members#576
jonathanpeppers wants to merge 3 commits into
mainfrom
jonathanpeppers-document-java-logging-apis

Conversation

@jonathanpeppers

@jonathanpeppersjonathanpeppers commented Aug 15, 2026

Copy link
Copy Markdown
Member

Sources

Validation

  • Parsed all docs/xml/Java.Util.Logging/*.xml files as XML.
  • Confirmed CRLF line endings for every scoped XML file.
  • Confirmed zero To be added. placeholders in Java.Util.Logging (excluding docs/xml/index.xml).
  • Ran git diff --check.

Refs #251

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

CopilotAI 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 generated XML documentation for the Java.Util.Logging namespace, replacing placeholder text and improving member documentation consistency with existing JNI binding doc patterns across the repo.

Changes:

  • Replaces To be added. placeholders for JniPeerMembers property docs across multiple Java.Util.Logging types.
  • Documents LoggingPermission(string name, string actions) parameters and constructor summary.

Reviewed changes

Copilot reviewed 15 out of 15 changed files in this pull request and generated 15 comments.

Show a summary per file
FileDescription
docs/xml/Java.Util.Logging/XMLFormatter.xmlReplaces placeholder JniPeerMembers docs.
docs/xml/Java.Util.Logging/StreamHandler.xmlReplaces placeholder JniPeerMembers docs.
docs/xml/Java.Util.Logging/SocketHandler.xmlReplaces placeholder JniPeerMembers docs.
docs/xml/Java.Util.Logging/SimpleFormatter.xmlReplaces placeholder JniPeerMembers docs.
docs/xml/Java.Util.Logging/MemoryHandler.xmlReplaces placeholder JniPeerMembers docs.
docs/xml/Java.Util.Logging/LogRecord.xmlReplaces placeholder JniPeerMembers docs.
docs/xml/Java.Util.Logging/LogManager.xmlReplaces placeholder JniPeerMembers docs.
docs/xml/Java.Util.Logging/LoggingPermission.xmlDocuments ctor parameters/summary and replaces placeholder JniPeerMembers docs.
docs/xml/Java.Util.Logging/Logger.xmlReplaces placeholder JniPeerMembers docs.
docs/xml/Java.Util.Logging/Level.xmlReplaces placeholder JniPeerMembers docs.
docs/xml/Java.Util.Logging/Handler.xmlReplaces placeholder JniPeerMembers docs.
docs/xml/Java.Util.Logging/Formatter.xmlReplaces placeholder JniPeerMembers docs.
docs/xml/Java.Util.Logging/FileHandler.xmlReplaces placeholder JniPeerMembers docs.
docs/xml/Java.Util.Logging/ErrorManager.xmlReplaces placeholder JniPeerMembers docs.
docs/xml/Java.Util.Logging/ConsoleHandler.xmlReplaces placeholder JniPeerMembers docs.

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

Comment threaddocs/xml/Java.Util.Logging/XMLFormatter.xml Outdated
Comment threaddocs/xml/Java.Util.Logging/StreamHandler.xml Outdated
Comment threaddocs/xml/Java.Util.Logging/SocketHandler.xml Outdated
Comment threaddocs/xml/Java.Util.Logging/SimpleFormatter.xml Outdated
Comment threaddocs/xml/Java.Util.Logging/MemoryHandler.xml Outdated
Comment threaddocs/xml/Java.Util.Logging/Handler.xml Outdated
Comment threaddocs/xml/Java.Util.Logging/Formatter.xml Outdated
Comment threaddocs/xml/Java.Util.Logging/FileHandler.xml Outdated
Comment threaddocs/xml/Java.Util.Logging/ErrorManager.xml Outdated
Comment threaddocs/xml/Java.Util.Logging/ConsoleHandler.xml Outdated
Refs #251
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@jonathanpeppers

Copy link
Copy Markdown
MemberAuthor

@dalexsoto review

@dalexsotodalexsoto left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LoggingPermission documents Java SE constructor restrictions but omits their NullPointerException/IllegalArgumentException behavior, while Android's implementation is a legacy stub that ignores both arguments. Please choose and document one complete authoritative contract rather than the current inconsistent hybrid: LoggingPermission.xml.

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

Copy link
Copy Markdown
MemberAuthor

@dalexsoto Addressed the requested change in 61879d5. The constructor documentation now describes the Android/AOSP contract: both supplied arguments are ignored and the base permission is initialized with empty name and actions values. The PR Sources section now links the Android reference and AOSP implementation.

@dalexsotodalexsoto left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The docs now consistently choose Android's stub behavior, but they claim both observable Name and Actions are always empty. On supported API 21–23 both are null, and on API 24–26 Name remains null; both become empty only from API 27. Please state only that constructor arguments are ignored, or document the API-specific observable values.

Sign up for freeto 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.

3 participants

@jonathanpeppers@dalexsoto