Document Javax.Xml.Parsers APIs - #421
Merged
jonathanpeppers merged 3 commits intoAug 14, 2026
Merged
Conversation
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
jonathanpeppers
requested review from
dalexsoto
and
a lite review from Copilot
August 14, 2026 08:25
jonathanpeppers
enabled auto-merge (squash)
August 14, 2026 08:25
There was a problem hiding this comment.
Pull request overview
This PR replaces “To be added.” placeholders with XML documentation for the Javax.Xml.Parsers namespace and key parser/builder APIs, aligning docs with Java SE / Android reference material.
Changes:
- Added a namespace summary for
Javax.Xml.Parsers. - Filled in parameter/value documentation for factory
newInstance(String, ClassLoader)and several parser/builder properties. - Added reference links to Android documentation pages for selected members.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/xml/ns-Javax.Xml.Parsers.xml | Adds namespace-level summary describing SAX/DOM usage. |
| docs/xml/Javax.Xml.Parsers/SAXParserFactory.xml | Documents newInstance(String, ClassLoader) parameters. |
| docs/xml/Javax.Xml.Parsers/SAXParser.xml | Adds/updates <value> docs and inserts reference links for some properties (needs corrections in two updated members). |
| docs/xml/Javax.Xml.Parsers/DocumentBuilderFactory.xml | Documents newInstance(String, ClassLoader) parameters. |
| docs/xml/Javax.Xml.Parsers/DocumentBuilder.xml | Adds <value> docs and reference links for key properties (one wording tweak recommended). |
Suppressed comments (1)
docs/xml/Javax.Xml.Parsers/SAXParser.xml:1208
ParserreturnsOrg.Xml.Sax.IParser, but the<value>text and the reference link currently describegetXMLReader()/IXMLReader. This is misleading and should describegetParser()/IParserinstead.
<summary>Returns the SAX parser that is encapsulated by the
implementation of this class.</summary>
<value>The <see cref="T:Org.Xml.Sax.IXMLReader" /> encapsulated by this implementation.</value>
<remarks>
<para>
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
jonathanpeppers
requested review from
dalexsoto
and removed request for
dalexsoto
August 14, 2026 08:36
Member
Author
|
@dalexsoto review |
Resolve overlapping parser documentation using main's authoritative wording while preserving the namespace summary and reviewed JNI metadata documentation. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: e2b31149-4b69-4d90-b91f-af39ae1848b1
jonathanpeppers
requested review from
dalexsoto
and removed request for
dalexsoto
August 14, 2026 16:43
dalexsoto
approved these changes
Aug 14, 2026
dalexsoto
left a comment
dalexsoto
left a comment
Member
There was a problem hiding this comment.
The SAXParser and namespace documentation matches the Android/Java contracts and renders correctly.
jonathanpeppers
deleted the
jonathanpeppers-document-java-xml-parser-apis
branch
August 14, 2026 17:00
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 #280
Sources
javax.xml.parserspackage summaryDocumentBuilderreferenceSAXParserreferenceDocumentBuilderFactory.newInstance(String, ClassLoader)SAXParserFactory.newInstance(String, ClassLoader)Validation
docs/xml/ns-Javax.Xml.Parsers.xmland all sixdocs/xml/Javax.Xml.Parsers/*.xmlfiles with PowerShell's XML parser.git diff --check.docs/xml/index.xmlis unchanged.