Skip to content

Conversation

@hawjo01
Copy link
Contributor

@hawjo01 hawjo01 commented Oct 23, 2025

The javadoc for the XmlStreamReader and XmlStreamReader.Builder classes incorrectly states that it builds instances of XmlStreamWriter. This PR fixes the javadoc to state the correct type of class that is is returned.

Thanks for your contribution to Apache Commons! Your help is appreciated!

Before you push a pull request, review this list:

  • Read the contribution guidelines for this project.
  • Read the ASF Generative Tooling Guidance if you use Artificial Intelligence (AI).
  • I used AI to create any part of, or all of, this pull request.
  • Run a successful build using the default Maven goal with mvn; that's mvn on the command line by itself.
  • Write unit tests that match behavioral changes, where the tests fail if the changes to the runtime are not applied. This may not always be possible, but it is a best practice.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Each commit in the pull request should have a meaningful subject line and body. Note that a maintainer may squash commits during the merge process.

@hawjo01 hawjo01 changed the title Fix javadoc to indicate the correct class that is built. [javadoc] Fix javadoc to indicate the correct class that is built. Oct 23, 2025
@garydgregory garydgregory merged commit 1cf65a6 into apache:master Oct 24, 2025
21 checks passed
@garydgregory garydgregory changed the title [javadoc] Fix javadoc to indicate the correct class that is built. [javadoc] Fix XmlStreamReader Javadoc to indicate the correct class that is built Oct 24, 2025
@hawjo01 hawjo01 deleted the xmlstreamreader-javadoc branch October 24, 2025 14:44
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.

2 participants