Skip to content

Document Javax.Xml.Parsers APIs - #417

Open
jonathanpeppers wants to merge 1 commit into
mainfrom
jonathanpeppers-document-xml-parsers
Open

Document Javax.Xml.Parsers APIs#417
jonathanpeppers wants to merge 1 commit into
mainfrom
jonathanpeppers-document-xml-parsers

Conversation

@jonathanpeppers

Copy link
Copy Markdown
Member

Refs #280

Summary

  • Document the Javax.Xml.Parsers namespace and seven Android-backed DOM/SAX parser property values.
  • Document the factoryClassName and classLoader parameters of the named DocumentBuilderFactory and SAXParserFactory overloads.
  • Leave generated async and JNI binding members out of scope; their Java API reference pages do not document those .NET-specific members.

Sources

Validation

  • Parsed the changed XML documentation files with System.Xml.XmlReader.
  • Confirmed CRLF line endings for the namespace and all Javax.Xml.Parsers XML files.
  • Ran git diff --check.
  • Confirmed no To be added. placeholders remain in the scoped namespace summary, seven properties, or two factory overloads.

Refs #280

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 improves the .NET XML documentation for the Javax.Xml.Parsers surface area by replacing remaining To be added. placeholders with concise, Android-aligned API descriptions for the namespace, key parser properties, and the named factory overload parameters.

Changes:

  • Adds a namespace summary for Javax.Xml.Parsers.
  • Documents factoryClassName and classLoader parameters on the named newInstance overloads for DocumentBuilderFactory and SAXParserFactory.
  • Replaces To be added. placeholders for several DocumentBuilder/SAXParser property <value> descriptions (namespace aware, validating, and encapsulated parser/reader).

Reviewed changes

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

Show a summary per file
File Description
docs/xml/ns-Javax.Xml.Parsers.xml Replaces the namespace To be added. summary with a concise description of the parsing APIs.
docs/xml/Javax.Xml.Parsers/SAXParserFactory.xml Documents factoryClassName and classLoader params for the named factory overload.
docs/xml/Javax.Xml.Parsers/SAXParser.xml Replaces placeholder <value> text for key parser configuration and encapsulated parser/reader properties.
docs/xml/Javax.Xml.Parsers/DocumentBuilderFactory.xml Documents factoryClassName and classLoader params for the named factory overload.
docs/xml/Javax.Xml.Parsers/DocumentBuilder.xml Replaces placeholder <value> text for DOM implementation and parser configuration properties.

💡 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

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.

2 participants