Repository navigation
javadoc: clarify statelessTestsetReporter, consoleOutputReporter, - #3410
Merged
Merged
Conversation
statelessTestsetInfoReporter parameters Closes apache#3386
There was a problem hiding this comment.
Pull request overview
This PR improves the usability of the Surefire plugin configuration by adding missing Javadoc for three @Parameter extension/reporter fields in AbstractSurefireMojo, clarifying what each reporter controls and pointing users to the JUnit Platform example page for the full nested configuration options.
Changes:
- Documented
statelessTestsetReporteras the configuration entry point for XMLTEST-*.xmlreporting, including precedence notes for the deprecateddisableXmlReport. - Documented
consoleOutputReporterfor captured stdout/stderr handling, includingredirectTestOutputToFile,disable, andencoding. - Documented
statelessTestsetInfoReporteras the configuration for the per-testset console/text summary reporter.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds Javadoc to the three undocumented @parameter fields in
AbstractSurefireMojo, describing what each reporter controls and
linking to the JUnit 5 Platform example page for the full list of
nested configuration elements.
Closes #3386
Following this checklist to help us incorporate your
contribution quickly and easily:
mvn clean installto make sure basic checks pass. A more thorough check willbe performed on your pull request automatically.
mvn -Prun-its clean install).If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.
To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.
I hereby declare this contribution to be licenced under the Apache License Version 2.0, January 2004
In any other case, please file an Apache Individual Contributor License Agreement.