Skip to content

Fix SAX parser factory feature documentation - #617

Open
jonathanpeppers wants to merge 2 commits into
mainfrom
jonathanpeppers-recover-javax-xml-parser-docs
Open

Fix SAX parser factory feature documentation#617
jonathanpeppers wants to merge 2 commits into
mainfrom
jonathanpeppers-recover-javax-xml-parser-docs

Conversation

@jonathanpeppers

Copy link
Copy Markdown
Member

Summary

  • Restore the org.xml.sax.XMLReader type omitted from the synchronous SAXParserFactory.GetFeature summary.
  • Correct the related-member link to IXMLReader.GetFeature, rather than the unrelated property API.

Refs #280

Sources

Validation

  • Parsed docs/xml/Javax.Xml.Parsers/SAXParserFactory.xml with PowerShell's XML parser.
  • Confirmed the changed XML file has zero lone LF line endings.
  • Ran git diff --check.
  • Confirmed the scoped SAXParserFactory.GetFeature To be added. count is 0.
  • Confirmed the namespace has 52 remaining To be added. occurrences: 42 generated SAXParser.ParseAsync fields and 10 generated JniPeerMembers fields, all excluded from this change.
  • Confirmed docs/xml/index.xml is unchanged.

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 XML documentation for Javax.Xml.Parsers.SAXParserFactory.GetFeature(string) to better match the underlying SAX API surface, aligning the summary text and related-member link with org.xml.sax.XMLReader / IXMLReader.GetFeature.

Changes:

  • Restores the missing org.xml.sax.XMLReader type reference in the GetFeature summary text.
  • Updates the related-member link to point at Org.Xml.Sax.IXMLReader.GetFeature(string).
Suppressed comments (1)

docs/xml/Javax.Xml.Parsers/SAXParserFactory.xml:146

  • These exception descriptions still talk about the XMLReader “property name”, but this method is GetFeature; the exception text should match the feature terminology.
        <exception cref="T:Javax.Xml.Parsers.ParserConfigurationException">if a parser cannot be created which satisfies the requested configuration.</exception>
        <exception cref="T:Org.Xml.Sax.SAXNotRecognizedException">When the underlying XMLReader does not recognize the property name.</exception>
        <exception cref="T:Org.Xml.Sax.SAXNotSupportedException">When the underlying XMLReader recognizes the property name but doesn't support the property.</exception>
        <altmember cref="M:Org.Xml.Sax.IXMLReader.GetFeature(System.String)" />

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

Comment thread docs/xml/Javax.Xml.Parsers/SAXParserFactory.xml Outdated
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@jonathanpeppers
jonathanpeppers requested review from dalexsoto and removed request for dalexsoto August 16, 2026 16:33
@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.

SAXParserFactory.GetFeature(string? name) accepts null at compile time, but Android explicitly throws Java.Lang.NullPointerException for null and the revised docs omit that requirement and exception. Please document the non-null input contract consistently with SetFeature: SAXParserFactory.xml.

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