Merge pull request #243 from aubi/fix-tck-javadoc

Fix TCK JavaDoc
jakartaee · Jun 30, 2022 · 03087f5 · 03087f5
2 parents 632975e + 74d7bd8
commit 03087f5
Show file tree

Hide file tree

Showing 7 changed files with 23 additions and 21 deletions.
diff --git a/api/src/main/java/jakarta/enterprise/concurrent/ContextServiceDefinition.java b/api/src/main/java/jakarta/enterprise/concurrent/ContextServiceDefinition.java
@@ -216,7 +216,7 @@
      * any global transaction that was previously present there is
      * first suspended such that the contextual task or action can
      * begin and manage, as permitted by the container, its own new
-     * {@link jakarta.transaction.UserTransaction}.
+     * {@code jakarta.transaction.UserTransaction}.
      * After the contextual task or action completes, the prior
      * transaction is resumed on the thread. This is equivalent to
      * the execution property, {@link ManagedTask#TRANSACTION} with

diff --git a/tck/pom.xml b/tck/pom.xml
@@ -141,6 +141,24 @@
                     </execution>
                 </executions>
             </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-javadoc-plugin</artifactId>
+                <version>3.4.0</version>
+                <executions>
+                    <execution>
+                        <id>attach-api-javadocs</id>
+                        <goals>
+                            <goal>jar</goal>
+                        </goals>
+                        <configuration>
+                            <source>11</source>
+                            <quiet>true</quiet>                          
+                            <additionalJOption>-Xdoclint:none</additionalJOption>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
         </plugins>
     </build>
 

diff --git a/tck/src/main/java/ee/jakarta/tck/concurrent/framework/TestUtil.java b/tck/src/main/java/ee/jakarta/tck/concurrent/framework/TestUtil.java
@@ -65,7 +65,7 @@ public final class TestUtil {
 	 * HTTP convenience method for servlets to get a response from another servlet. 
 	 * Test clients should extend the {@link TestClient} class that has its own HTTP methods.
 	 * 
-	 * @param connection - the URLConnection
+	 * @param con - the URLConnection
 	 * @return String - response body
 	 * @throws IOException
 	 */

diff --git a/tck/src/main/java/ee/jakarta/tck/concurrent/framework/signaturetest/SigTest.java b/tck/src/main/java/ee/jakarta/tck/concurrent/framework/signaturetest/SigTest.java
@@ -21,14 +21,10 @@
 
 package ee.jakarta.tck.concurrent.framework.signaturetest;
 
-import java.io.BufferedReader;
-import java.io.File;
-import java.io.InputStreamReader;
 import java.io.PrintWriter;
 import java.io.PrintStream;
 
 import java.util.ArrayList;
-import java.util.Properties;
 
 /**
  * This class should be extended by TCK developers that wish to create a set of
@@ -167,9 +163,6 @@ protected String[] getClasses() {
 	 * retrieves some state information that is necessary to run the test when when
 	 * the test framework invokes the run method (actually the test1 method).
 	 *
-	 * @param args List of arguments passed to this test.
-	 * @param p    Properties specified by the test user and passed to this test via
-	 *             the test framework.
 	 * @throws Fault When an error occurs reading or saving the state information
 	 *               processed by this method.
 	 */

diff --git a/tck/src/main/java/ee/jakarta/tck/concurrent/framework/signaturetest/SigTestEE.java b/tck/src/main/java/ee/jakarta/tck/concurrent/framework/signaturetest/SigTestEE.java
@@ -19,7 +19,6 @@
 import java.io.BufferedReader;
 import java.io.File;
 import java.io.InputStreamReader;
-import java.io.IOException;
 import java.io.PrintWriter;
 import java.io.PrintStream;
 
@@ -196,13 +195,6 @@ protected String[] getClasses(String vehicleName) {
 	 * Called by the test framework to initialize this test. The method simply
 	 * retrieves some state information that is necessary to run the test when when
 	 * the test framework invokes the run method (actually the test1 method).
-	 *
-	 * @param args List of arguments passed to this test.
-	 * @param p    Properties specified by the test user and passed to this test via
-	 *             the test framework.
-	 *
-	 * @throws Fault When an error occurs reading or saving the state information
-	 *               processed by this method.
 	 */
 	public void setup() {
 		try {

diff --git a/tck/src/main/java/ee/jakarta/tck/concurrent/framework/signaturetest/SignatureTestDriver.java b/tck/src/main/java/ee/jakarta/tck/concurrent/framework/signaturetest/SignatureTestDriver.java
@@ -140,7 +140,7 @@ public void cleanupImpl() throws Exception {
 	/**
 	 * <p>
 	 * Execute the signature test. By default, this method passes the result of
-	 * {@link #createTestArguments(String, String, String, String, String)} and
+	 * {@link #createTestArguments(String, String, String, String, String, boolean)} and
 	 * passes the result to {@link #runSignatureTest(String, String[])}.
 	 *
 	 * @param packageListFile        - file containing the packages/classes that are

diff --git a/...tck/concurrent/spec/ManagedExecutorService/resourcedef/ManagedExecutorDefinitionBean.java b/...tck/concurrent/spec/ManagedExecutorService/resourcedef/ManagedExecutorDefinitionBean.java
@@ -15,17 +15,16 @@
  */
 package ee.jakarta.tck.concurrent.spec.ManagedExecutorService.resourcedef;
 
-import jakarta.annotation.Resource;
 import jakarta.ejb.Local;
 import jakarta.ejb.Stateless;
 import jakarta.enterprise.concurrent.ManagedExecutorDefinition;
-import jakarta.enterprise.concurrent.ManagedExecutorService;
 
 import javax.naming.InitialContext;
 import javax.naming.NamingException;
 
 /**
- * ContextServiceDefinitions are defined under {@link ContextServiceDefinitionBean}
+ * ContextServiceDefinitions are defined under
+ * {@link ee.jakarta.tck.concurrent.spec.ContextService.contextPropagate.ContextServiceDefinitionBean}
  */
 @ManagedExecutorDefinition(name = "java:app/concurrent/EJBExecutorA",
                            context = "java:app/concurrent/EJBContextA",