(maven-surefire) branch master updated: Improve docs of linkXRef

[mi...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

michaelo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-surefire.git


The following commit(s) were added to refs/heads/master by this push:
     new bce1b39b0 Improve docs of linkXRef
bce1b39b0 is described below

commit bce1b39b042f8cd696c2bc9b9205303aff6409ae
Author: Michael Osipov <mi...@apache.org>
AuthorDate: Sun Jun 30 00:15:18 2024 +0200

    Improve docs of linkXRef
---
 .../maven/plugins/surefire/report/AbstractSurefireReportMojo.java      | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/maven-surefire-report-plugin/src/main/java/org/apache/maven/plugins/surefire/report/AbstractSurefireReportMojo.java b/maven-surefire-report-plugin/src/main/java/org/apache/maven/plugins/surefire/report/AbstractSurefireReportMojo.java
index 3ec4928f9..c4234e4a7 100644
--- a/maven-surefire-report-plugin/src/main/java/org/apache/maven/plugins/surefire/report/AbstractSurefireReportMojo.java
+++ b/maven-surefire-report-plugin/src/main/java/org/apache/maven/plugins/surefire/report/AbstractSurefireReportMojo.java
@@ -90,7 +90,8 @@ public abstract class AbstractSurefireReportMojo extends AbstractMavenReport {
     private File xrefLocation;
 
     /**
-     * Whether to link the XRef if found.
+     * Link the failed tests line numbers to the source xref. Will link
+     * automatically if Maven JXR plugin is being used.
      */
     @Parameter(defaultValue = "true", property = "linkXRef")
     private boolean linkXRef;