Skip to content

Document LoggingPermission constructor - #460

Open
jonathanpeppers wants to merge 1 commit into
mainfrom
jonathanpeppers-java-util-logging-docs
Open

Document LoggingPermission constructor#460
jonathanpeppers wants to merge 1 commit into
mainfrom
jonathanpeppers-java-util-logging-docs

Conversation

@jonathanpeppers

Copy link
Copy Markdown
Member

Refs #251

Documents the Java SE LoggingPermission(String, String) contract while leaving generated interop placeholders and unverified members out of scope.

Sources

Validation

  • Parsed every docs/xml/Java.Util.Logging/*.xml file as XML.
  • Confirmed CRLF line endings throughout the namespace.
  • Ran git diff --check and reviewed the focused namespace diff.

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

Updates the API XML documentation for Java.Util.Logging.LoggingPermission to reflect the Java SE contract for the LoggingPermission(String, String) constructor, replacing “To be added.” placeholders with concrete parameter and summary text.

Changes:

  • Documented the required name value (control) for the constructor.
  • Documented the allowed actions values (null or empty string).
  • Added a concise constructor <summary>.

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

@jonathanpeppers

Copy link
Copy Markdown
Member Author

@dalexsoto review

@dalexsoto dalexsoto 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.

docs/xml/Java.Util.Logging/LoggingPermission.xml: the constructor documents the accepted values but omits its enforced failure behavior. A null name throws Java.Lang.NullPointerException, while an empty/invalid name or invalid actions throw Java.Lang.IllegalArgumentException. Please document both exceptions.

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.

3 participants