Improve docs of linkXRef

apache · Jun 29, 2024 · bce1b39 · bce1b39
1 parent 3c49ebd
commit bce1b39
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/...in/src/main/java/org/apache/maven/plugins/surefire/report/AbstractSurefireReportMojo.java b/...in/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;