Fix SAX parser factory feature documentation - #617
Conversation
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
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.XMLReadertype reference in theGetFeaturesummary 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.
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
|
@dalexsoto review |
dalexsoto
left a comment
There was a problem hiding this comment.
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.
Summary
org.xml.sax.XMLReadertype omitted from the synchronousSAXParserFactory.GetFeaturesummary.IXMLReader.GetFeature, rather than the unrelated property API.Refs #280
Sources
SAXParserFactory.getFeature(String)referenceXMLReader.getFeature(String)referenceSAXParserFactory.getFeature(String)referenceValidation
docs/xml/Javax.Xml.Parsers/SAXParserFactory.xmlwith PowerShell's XML parser.git diff --check.SAXParserFactory.GetFeatureTo be added.count is0.52remainingTo be added.occurrences:42generatedSAXParser.ParseAsyncfields and10generatedJniPeerMembersfields, all excluded from this change.docs/xml/index.xmlis unchanged.