Add JavaDoc to configuration methods

apache · Apr 12, 2022 · 43db898 · 43db898
1 parent bdcf3a0
commit 43db898
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/...ire-testng/src/main/java/org/apache/maven/surefire/testng/conf/TestNG740Configurator.java b/...ire-testng/src/main/java/org/apache/maven/surefire/testng/conf/TestNG740Configurator.java
@@ -39,6 +39,13 @@
 public class TestNG740Configurator
     extends TestNG60Configurator
 {
+    /**
+     * Convert and apply the value of the [threadcount] option.
+     * 
+     * @param suite TestNG {@link XmlSuite} object
+     * @param options Surefire plugin configuration options
+     * @throws TestSetFailedException if unable to convert specified [threadcount] setting
+     */
     @Override
     protected void configureThreadCount( XmlSuite suite, Map<String, String> options )
         throws TestSetFailedException
@@ -59,6 +66,17 @@ protected void configureThreadCount( XmlSuite suite, Map<String, String> options
         }
     }
 
+    /**
+     * Convert and apply the value of the [parallel] setting.
+     * <p>
+     * <b>NOTE</b>: Since TestNG 7.4, the value of the {@code parallel} setting of the {@link XmlSuite} class has been
+     * specified via a <b>ParallelMode</b> enumeration. This method converts the [parallel] setting specified in the
+     * Surefire plugin configuration to its corresponding constant and applies this to the specified suite object.
+     * 
+     * @param suite TestNG {@link XmlSuite} object
+     * @param options Surefire plugin configuration options
+     * @throws TestSetFailedException if unable to convert specified [parallel] setting
+     */
     @Override
     protected void configureParallel( XmlSuite suite, Map<String, String> options )
         throws TestSetFailedException