Skip to content

Document Java XML transform source metadata - #451

Open
jonathanpeppers wants to merge 1 commit into
mainfrom
jonathanpeppers-document-java-xml-transform-apis
Open

Document Java XML transform source metadata#451
jonathanpeppers wants to merge 1 commit into
mainfrom
jonathanpeppers-document-java-xml-transform-apis

Conversation

@jonathanpeppers

Copy link
Copy Markdown
Member

Sources

Validation

  • python tools\\regenerate_android_app_docs.py --validate docs\\xml\\Javax.Xml.Transform\\IResult.xml docs\\xml\\Javax.Xml.Transform\\ISource.xml docs\\xml\\Javax.Xml.Transform\\ISourceLocator.xml docs\\xml\\Javax.Xml.Transform\\ITemplates.xml
  • XML parse, CRLF preservation, and git diff --check

Refs #264

Refs #264

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 the Javax.Xml.Transform bindings by replacing “To be added.” placeholders with meaningful <value> metadata text, aligned with the Android/Java API references and the repo’s documentation style.

Changes:

  • Documented SystemId property values for ISource and IResult to describe the identifier set via setSystemId.
  • Documented ISourceLocator property values (ColumnNumber, LineNumber, PublicId, SystemId) with concrete descriptions.
  • Documented ITemplates.OutputProperties value text to describe the effective xsl:output properties.

Reviewed changes

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

File Description
docs/xml/Javax.Xml.Transform/ITemplates.xml Replaces placeholder <value> text for OutputProperties with a specific description.
docs/xml/Javax.Xml.Transform/ISourceLocator.xml Replaces placeholder <value> text for source location metadata properties.
docs/xml/Javax.Xml.Transform/ISource.xml Replaces placeholder <value> text for the SystemId property with a specific description.
docs/xml/Javax.Xml.Transform/IResult.xml Replaces placeholder <value> text for the SystemId property with a specific description.

💡 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

@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 PR currently has merge conflicts with the base branch. Please resolve the conflicts so the reviewed documentation changes can be merged.

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