From bce1b39b042f8cd696c2bc9b9205303aff6409ae Mon Sep 17 00:00:00 2001
From: Michael Osipov <michaelo@apache.org>
Date: Sun, 30 Jun 2024 00:15:18 +0200
Subject: [PATCH] Improve docs of linkXRef

---
 .../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 3ec4928f93..c4234e4a73 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;