Skip to content

Document XmlPullParserFactory values - #635

Merged
jonathanpeppers merged 2 commits into
mainfrom
jonathanpeppers-document-xml-pull-apis-2cf
Aug 18, 2026
Merged

Document XmlPullParserFactory values#635
jonathanpeppers merged 2 commits into
mainfrom
jonathanpeppers-document-xml-pull-apis-2cf

Conversation

@jonathanpeppers

Copy link
Copy Markdown
Member

Summary

  • Document eight source-supported XmlPullParserFactory values and return/parameter details.
  • Leave the two JNI-binding placeholders untouched because they have no matching Java/Android source documentation.

Refs #250

Sources

Validation

  • Parsed all 9 Org.XmlPull.V1 XML documents successfully.
  • Preserved CRLF line endings (0 bare LF lines).
  • Scoped To be added placeholders: 182 -> 174; XmlPullParserFactory: 10 -> 2.
  • git diff --check

Refs #250

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 generated XML documentation for Org.XmlPull.V1.XmlPullParserFactory by replacing several To be added. placeholders with source-backed descriptions of properties, parameters, and return values, while explicitly leaving JNI-binding placeholders untouched when no matching Android/Java docs exist.

Changes:

  • Documented previously-undocumented property <value> text (e.g., feature map, parser/serializer class lists, and an unused compatibility property).
  • Added <returns> documentation for both NewInstance() overloads and clarified unused parameters on the 2-arg overload.

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

Comment thread docs/xml/Org.XmlPull.V1/XmlPullParserFactory.xml Outdated
Refs #250

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@jonathanpeppers
jonathanpeppers requested review from dalexsoto and removed request for dalexsoto August 17, 2026 13:30
@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.

The XmlPullParserFactory values, creation contracts, managed signatures, and attribution match the source APIs.

auto-merge was automatically disabled August 18, 2026 01:15

Pull request was closed

@jonathanpeppers
jonathanpeppers enabled auto-merge (squash) August 18, 2026 01:15
@jonathanpeppers
jonathanpeppers merged commit 4b1e489 into main Aug 18, 2026
3 checks passed
@jonathanpeppers
jonathanpeppers deleted the jonathanpeppers-document-xml-pull-apis-2cf branch August 18, 2026 01:37
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