Fix se 17 javadoc error (#510)

add javadoc to the non-stage ci build

Signed-off-by: Scott M Stark <[email protected]>

.github/workflows/ci-actions.yml

@@ -28,4 +28,4 @@ jobs:
           mvn clean install -Pstaging -B -V
       - name: "Maven install"
         run: |
-          mvn clean install -B -V
+          mvn clean install -B -V javadoc:javadoc

api/pom.xml

@@ -5,7 +5,7 @@
 	<parent>
 		<groupId>jakarta.enterprise</groupId>
 		<artifactId>cdi-tck-parent</artifactId>
-		<version>4.1.0.SNAPSHOT</version>
+		<version>4.1.0-SNAPSHOT</version>
 	</parent>
 
 	<artifactId>cdi-tck-api</artifactId>

dist-build/libs/pom.xml

@@ -3,7 +3,7 @@
     <parent>
         <groupId>jakarta.enterprise</groupId>
         <artifactId>cdi-tck-parent</artifactId>
-        <version>4.1.0.SNAPSHOT</version>
+        <version>4.1.0-SNAPSHOT</version>
         <relativePath>../../pom.xml</relativePath>
     </parent>
 

dist-build/pom.xml

@@ -4,7 +4,7 @@
    <parent>
       <groupId>jakarta.enterprise</groupId>
       <artifactId>cdi-tck-parent</artifactId>
-      <version>4.1.0.SNAPSHOT</version>
+      <version>4.1.0-SNAPSHOT</version>
       <relativePath>../pom.xml</relativePath>
    </parent>
 

dist-build/porting-package/pom.xml

@@ -4,7 +4,7 @@
     <parent>
         <groupId>jakarta.enterprise</groupId>
         <artifactId>cdi-tck-parent</artifactId>
-        <version>4.1.0.SNAPSHOT</version>
+        <version>4.1.0-SNAPSHOT</version>
         <relativePath>../../pom.xml</relativePath>
     </parent>
 

doc/reference/pom.xml

@@ -10,7 +10,7 @@
     <parent>
         <groupId>jakarta.enterprise</groupId>
         <artifactId>cdi-tck-parent</artifactId>
-        <version>4.1.0.SNAPSHOT</version>
+        <version>4.1.0-SNAPSHOT</version>
         <relativePath>../../pom.xml</relativePath>
     </parent>
 

ext-lib/pom.xml

@@ -3,7 +3,7 @@
     <parent>
         <artifactId>cdi-tck-parent</artifactId>
         <groupId>jakarta.enterprise</groupId>
-        <version>4.1.0.SNAPSHOT</version>
+        <version>4.1.0-SNAPSHOT</version>
     </parent>
     <artifactId>cdi-tck-ext-lib</artifactId>
     <name>CDI TCK Installed Library - test bean archive</name>

impl/pom.xml

@@ -3,7 +3,7 @@
     <parent>
         <artifactId>cdi-tck-parent</artifactId>
         <groupId>jakarta.enterprise</groupId>
-        <version>4.1.0.SNAPSHOT</version>
+        <version>4.1.0-SNAPSHOT</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
     <artifactId>cdi-tck-core-impl</artifactId>

impl/src/main/java/org/jboss/cdi/tck/AbstractTest.java

@@ -127,7 +127,7 @@ protected boolean annotationSetMatches(Set<? extends Annotation> annotations,
 
     /**
      * @param annotations The annotation set
-     * @param requiredAnnotationTypes The required annotations
+     * @param requiredAnnotations The required annotations
      * @return <code>true</code> if the specified set matches required annotations, <code>false</code> otherwise
      */
     protected boolean annotationSetMatches(Set<? extends Annotation> annotations, Annotation... requiredAnnotations) {

impl/src/main/java/org/jboss/cdi/tck/impl/testng/SingleTestClassMethodInterceptor.java

@@ -17,12 +17,18 @@
 
 /**
  * This {@link IMethodInterceptor} fixes one or the other problem with CDI TCK test suite execution:
- * <ol>
- * <li>Run tests from single test class - it seems that Maven Surefire plugin is not able to run single test that is located outside src/test dir. If test class
- * system property is set all test methods that don't belong to specified test class are excluded.</li>
- * <li>Avoid randomly mixed test method execution - causing test archive deployments collisions. If test class system property is not set group test methods by
- * test class.</li>
- * <ol>
+ * <ul>
+ * <li>
+ *     Run tests from single test class - it seems that Maven Surefire plugin is not able to run single test that is located outside src/test dir. If test class
+ * </li>
+ * <li>
+ *     system property is set all test methods that don't belong to specified test class are excluded.
+ * </li>
+ * <li>
+ *     Avoid randomly mixed test method execution - causing test archive deployments collisions. If test class system property is not set group test methods by
+ * test class.
+ * </li>
+ * </ul>
  *
  * @author Stuart Douglas
  * @author Martin Kouba

impl/src/main/java/org/jboss/cdi/tck/interceptors/tests/bindings/aroundConstruct/ConstructorInterceptionTest.java

@@ -36,7 +36,7 @@
 /**
  * <p>
  * This test was originally part of the Weld test suite.
- * <p>
+ * </p>
  *
  * @author Jozef Hartinger
  * @author Martin Kouba

impl/src/main/java/org/jboss/cdi/tck/interceptors/tests/bindings/overriding/InterceptorBindingOverridingTest.java

@@ -35,7 +35,7 @@
  *
  * <p>
  * This test was originally part of Weld test suite.
- * <p>
+ * </p>
  *
  * @author Jozef Hartinger
  * @author Martin Kouba

impl/src/main/java/org/jboss/cdi/tck/interceptors/tests/contract/aroundConstruct/AroundConstructTest.java

@@ -41,7 +41,7 @@
 /**
  * <p>
  * This test was originally part of the Weld test suite.
- * <p>
+ * </p>
  *
  * @author Jozef Hartinger
  * @author Martin Kouba

impl/src/main/java/org/jboss/cdi/tck/interceptors/tests/contract/aroundConstruct/bindings/AroundConstructTest.java

@@ -38,7 +38,7 @@
 /**
  * <p>
  * This test was originally part of the Weld test suite.
- * <p>
+ * </p>
  *
  * @author Jozef Hartinger
  * @author Martin Kouba

impl/src/main/java/org/jboss/cdi/tck/shrinkwrap/ArchiveBuilder.java

@@ -169,7 +169,7 @@ public T withName(String name) {
 
     /**
      * Add <code>beans.xml</code> located in src/main/resource/{testPackagePath}.
-     * <p/>
+     *
      * <p>
      * In most cases, the alternative method {@link #withBeansXml(BeansXml)} should be used instead.
      * However, this variant is still useful if the test needs a very specific beans.xml file such as completely empty
@@ -293,7 +293,7 @@ public T withClasses(Class<?>... classes) {
     /**
      * Specified class must be excluded from final archive unless also added via {@link #withClass(Class)} or {@link #withClasses(Class...)}. Useful for
      * exluding some classes from package added via {@link #withPackage(Package)}.
-     * <p/>
+     * 
      * Avoid using this feature if possible - the implementation has negative performance effects.
      *
      * @param clazz Fully qualified class name
@@ -310,7 +310,7 @@ public T withExcludedClass(String clazz) {
     /**
      * Specified classes must be excluded from final archive unless also added via {@link #withClass(Class)} or {@link #withClasses(Class...)}. Useful for
      * exluding some classes from package added via {@link #withPackage(Package)}.
-     * <p/>
+     * 
      * Avoid using this feature if possible - the implementation has negative performance effects.
      *
      * @param classes Fully qualified class names
@@ -346,7 +346,7 @@ public T withTestClass(Class<?> testClazz) {
 
     /**
      * Set test class definition for configuration purpose. Do not add it to final archive.
-     * <p/>
+     * 
      * Always use this for as-client test archives, e.g. deployment method annotated with {@link ShouldThrowException}.
      *
      * @param testClazz
@@ -528,7 +528,7 @@ public T withEjbJarXml(EjbJarDescriptor descriptor) {
 
     /**
      * Add web.xml located in src/main/resource/{testPackagePath}.
-     * <p/>
+     * 
      * <p>
      * Do not use this in new tests - use {@link #withWebXml(WebAppDescriptor)} instead.
      * </p>
@@ -1287,7 +1287,7 @@ private String getTestPackagePath() {
 
     /**
      * Try to resolve as-client mode automatically unless it was set already.
-     * <p/>
+     * 
      * Set as-client mode to <code>true</code> provided that:
      * <ul>
      * <li>test class is annotated with {@link RunAsClient}</li>

impl/src/main/java/org/jboss/cdi/tck/shrinkwrap/URLPackageScanner.java

@@ -69,15 +69,16 @@ public class URLPackageScanner {
      *            flag to add child packages
      * @param classLoader
      *            class loader that will have classes added
-     * @param pkg
+     * @param callback
+     *          found class callback
+     * @param packageName
      *            Package that will be scanned
      * @return new instance of URLPackageScanner
      */
     public static URLPackageScanner newInstance(boolean addRecursively, final ClassLoader classLoader,
         final Callback callback, final String packageName) {
 
         validateNotNull(packageName, "Package name must be specified");
-        validateNotNull(addRecursively, "AddRecursively must be specified");
         validateNotNull(classLoader, "ClassLoader must be specified");
         validateNotNull(callback, "Callback must be specified");
 
@@ -87,16 +88,15 @@ public static URLPackageScanner newInstance(boolean addRecursively, final ClassL
     /**
      * Factory method to create an instance of URLPackageScanner in the default package
      *
-     * @param pkg
-     *            Package that will be scanned
      * @param addRecursively
      *            flag to add child packages
      * @param classLoader
      *            class loader that will have classes added
+     * @param callback
+     *          found class callback
      * @return new instance of URLPackageScanner
      */
     public static URLPackageScanner newInstance(boolean addRecursively, ClassLoader classLoader, Callback callback) {
-        validateNotNull(addRecursively, "AddRecursively must be specified");
         validateNotNull(classLoader, "ClassLoader must be specified");
         validateNotNull(callback, "Callback must be specified");
 

impl/src/main/java/org/jboss/cdi/tck/shrinkwrap/WebArchiveBuilder.java

@@ -37,7 +37,7 @@ public class WebArchiveBuilder extends ArchiveBuilder<WebArchiveBuilder, WebArch
 
     /**
      * Set the beans.xml descriptor target path base.
-     * <p/>
+     * 
      * By default the target base is <code>null</code> and the beans.xml descriptor is placed in WEB-INF dir. However CDI 1.1
      * allows an alternative location: WEB-INF/classes/META-INF.
      *

impl/src/main/java/org/jboss/cdi/tck/tests/context/alterable/AlterableContextTest.java

@@ -37,7 +37,7 @@
  * 
  * <p>
  * This test was originally part of the Weld test suite.
- * <p>
+ * </p>
  * 
  * @author Jozef Hartinger
  * @author Martin Kouba

impl/src/main/java/org/jboss/cdi/tck/tests/event/broken/observer/beanNotManaged/NonManagedBean.java

@@ -21,7 +21,7 @@
 
 /**
  * This class is not a bean since it does not have a default constructor nor does it have a constructor annotated with {@link
- * @Inject}. As such, an observer method is not detected on this class.
+ * jakarta.inject.Inject}. As such, an observer method is not detected on this class.
  * 
  * @author David Allen
  */

impl/src/main/java/org/jboss/cdi/tck/tests/event/fires/FireEventTest.java

@@ -95,7 +95,7 @@ public void testDuplicateBindingsToFireEventFails() throws Exception {
 
 /**
      * This test verifies that the {@link Event} object capable of firing {@link Item} objects can be injected with the {@link
-     * @Any} binding type and that the injected object can be used to fire an event. The functionality is verified by checking
+     * Any} binding type and that the injected object can be used to fire an event. The functionality is verified by checking
      * that the corresponding observer gets invoked.
      */
     // Simplify assertions
@@ -174,7 +174,7 @@ public void testInjectedEventAcceptsEventObject() throws SecurityException, NoSu
     }
 
     /**
-     * This test verifies that the {@link Event} object representing an {@link Item} with the {@link @Lifted} binding type is
+     * This test verifies that the {@link Event} object representing an {@link Item} with the {@link Lifted} binding type is
      * properly injected and that this object can be used to fire an event. The functionality is verified by checking that the
      * cooresponding observer gets invoked.
      */

impl/src/main/java/org/jboss/cdi/tck/tests/event/metadata/injectionpoint/EventMetadataInjectionPointTest.java

@@ -52,7 +52,8 @@
 import org.testng.annotations.Test;
 
 /**
- * Note that injection point is not available for {@link BeanManager#fireEvent()}.
+ * Note that injection point is not available for {@link BeanManager#getEvent()} {@link Event#select(Annotation...)}
+ * {@link Event#fire(Object)}.
  *
  * @author Martin Kouba
  */

impl/src/main/java/org/jboss/cdi/tck/tests/event/observer/broken/validation/unsatisfied/ObserverMethodParameterInjectionValidationTest.java

@@ -36,7 +36,7 @@
  * 
  * <p>
  * This test was originally part of Seam Compatibility project.
- * <p>
+ * </p>
  * 
  * @author <a href="http://community.jboss.org/people/dan.j.allen">Dan Allen</a>
  * @author Martin Kouba

impl/src/main/java/org/jboss/cdi/tck/tests/event/parameterized/ParameterizedEventTest.java

@@ -44,15 +44,16 @@
 /**
  * Test that verifies that the container uses the runtime type of the event object as the event type. If the event type contains
  * an unresolved type variable the selected type is used to resolve it.
- * <p/>
- * <p/>
+ * 
+ * 
  * This test was originally part of the Weld test suite.
- * <p/>
+ * 
  *
  * @author Jozef Hartinger
  * @author Martin Kouba
- * @see WELD-1272
- * @see CDI-256
+ *
+ * @see <a >WELD-1272</a>
+ * @see <a>CDI-256</a>
  */
 @SpecVersion(spec = "cdi", version = "2.0")
 public class ParameterizedEventTest extends AbstractTest {

impl/src/main/java/org/jboss/cdi/tck/tests/full/context/alterable/AlterableContextTest.java

@@ -39,7 +39,7 @@
  * 
  * <p>
  * This test was originally part of the Weld test suite.
- * <p>
+ * </p>
  * 
  * @author Jozef Hartinger
  * @author Martin Kouba

impl/src/main/java/org/jboss/cdi/tck/tests/full/context/passivating/custom/CustomPassivatingScopeCalledWithSerializableParametersTest.java

@@ -35,7 +35,7 @@
 /**
  * <p>
  * This test was originally part of the Weld test suite.
- * <p>
+ * </p>
  * 
  * @author Jozef Hartinger
  * @author Martin Kouba

impl/src/main/java/org/jboss/cdi/tck/tests/full/context/passivating/validation/DecoratorWithNonPassivationCapableDependenciesTest.java

@@ -38,7 +38,7 @@
  * 
  * <p>
  * This test was originally part of Weld test suite.
- * <p>
+ * </p>
  * 
  * @author Jozef Hartinger
  * @author Martin Kouba

impl/src/main/java/org/jboss/cdi/tck/tests/full/context/passivating/validation/InterceptorWithNonPassivationCapableDependenciesTest.java

@@ -36,7 +36,7 @@
  * 
  * <p>
  * This test was originally part of Weld test suite.
- * <p>
+ * </p>
  * 
  * @author Jozef Hartinger
  * @author Martin Kouba

impl/src/main/java/org/jboss/cdi/tck/tests/full/decorators/definition/broken/nodecoratedtypes/DecoratorWithNoDecoratedTypes1Test.java

@@ -33,7 +33,7 @@
 /**
  * <p>
  * This test was originally part of the Weld test suite.
- * <p>
+ * </p>
  * 
  * @author Jozef Hartinger
  * @author Martin Kouba

impl/src/main/java/org/jboss/cdi/tck/tests/full/decorators/definition/broken/nodecoratedtypes/DecoratorWithNoDecoratedTypes2Test.java

@@ -33,7 +33,7 @@
 /**
  * <p>
  * This test was originally part of the Weld test suite.
- * <p>
+ * </p>
  * 
  * @author Jozef Hartinger
  * @author Martin Kouba

impl/src/main/java/org/jboss/cdi/tck/tests/full/decorators/definition/broken/nodecoratedtypes/DecoratorWithNoDecoratedTypes3Test.java

@@ -35,7 +35,7 @@
 /**
  * <p>
  * This test was originally part of the Weld test suite.
- * <p>
+ * </p>
  * 
  * @author Jozef Hartinger
  * @author Martin Kouba

impl/src/main/java/org/jboss/cdi/tck/tests/full/decorators/definition/inject/delegateConstructor/TimestampLogger.java

@@ -48,7 +48,6 @@ public static Logger getConstructor() {
     }
 
     /**
-     * @param message the message to set
      */
     public static void reset() {
         constructor = null;

impl/src/main/java/org/jboss/cdi/tck/tests/full/decorators/definition/inject/delegateField/TimestampLogger.java

@@ -48,7 +48,6 @@ public static Logger getField() {
     }
 
     /**
-     * @param message the message to set
      */
     public static void reset() {
         field = null;