Add javadoc to package org.junit.jupiter.params.converter

#14

Author: Matthias Merdes

junit-jupiter-params/src/main/java/org/junit/jupiter/params/converter/ArgumentConversionException.java

@@ -16,6 +16,11 @@
 import org.junit.platform.commons.meta.API;
 
 /**
+ * {@code @ArgumentConversionException} is an exception that can
+ * occur when an object is converted to another object by an implementation
+ * of an {@code org.junit.jupiter.params.converter.ArgumentConverter}.
+ *
+ * @see org.junit.jupiter.params.converter.ArgumentConverter
  * @since 5.0
  */
 @API(Experimental)

junit-jupiter-params/src/main/java/org/junit/jupiter/params/converter/ArgumentConverter.java

@@ -16,6 +16,15 @@
 import org.junit.platform.commons.meta.API;
 
 /**
+ * {@code @ArgumentConverter} is an abtraction that allows an input object to
+ * be converted to an instance of a different class.
+ *
+ * Such an {@code @ArgumentConverter} is applied to the method parameter
+ * of a {@link org.junit.jupiter.params.ParameterizedTest} method with the help of an
+ * {@link org.junit.jupiter.params.converter.ConvertWith} annotation.
+ *
+ * @see org.junit.jupiter.params.ParameterizedTest
+ * @see org.junit.jupiter.params.converter.ConvertWith
  * @since 5.0
  */
 @API(Experimental)

junit-jupiter-params/src/main/java/org/junit/jupiter/params/converter/ConvertWith.java

@@ -18,9 +18,19 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.platform.commons.meta.API;
 
 /**
+ * {@code @ConvertWith} is an annotation that allows to to specify an explicit
+ * {@link org.junit.jupiter.params.converter.ArgumentConverter}.
+
+ * <p>This annotation may be applied to method parameters of
+ * {@link ParameterizedTest} methods which need to have their {@code Arguments}
+ * converted before consuming them.
+ *
+ * @see org.junit.jupiter.params.ParameterizedTest
+ * @see org.junit.jupiter.params.converter.ArgumentConverter
  * @since 5.0
  */
 @Target({ ElementType.ANNOTATION_TYPE, ElementType.PARAMETER })

junit-jupiter-params/src/main/java/org/junit/jupiter/params/converter/DefaultArgumentConverter.java

@@ -36,6 +36,16 @@
 import org.junit.platform.commons.util.ReflectionUtils;
 
 /**
+ * {@code @DefaultArgumentConverter} is the default implementation for the
+ * {@code @ArgumentConverter} abstraction.
+ *
+ * The {@code @DefaultArgumentConverter} is able to convert from strings to
+ * a number of primitive (Byte, Short, Integer, Long, Float, and Double)
+ * and date types.
+ *
+ * If the source and target types are identical the object is left unchanged.
+ *
+ * @see org.junit.jupiter.params.converter.ArgumentConverter
  * @since 5.0
  */
 @API(Internal)

junit-jupiter-params/src/main/java/org/junit/jupiter/params/converter/JavaTimeConversionPattern.java

@@ -18,9 +18,16 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.platform.commons.meta.API;
 
 /**
+ * {@code @JavaTimeConversionPattern} is an annotation that allows a time
+ * conversion pattern to be specified on a method parameter of a
+ * {@link ParameterizedTest} method.
+ *
+ * @see org.junit.jupiter.params.ParameterizedTest
+ * @see java.time.format.DateTimeFormatterBuilder#appendPattern(String)
  * @since 5.0
  */
 @Target({ ElementType.ANNOTATION_TYPE, ElementType.PARAMETER })

junit-jupiter-params/src/main/java/org/junit/jupiter/params/converter/SimpleArgumentConverter.java

@@ -16,6 +16,10 @@
 import org.junit.platform.commons.meta.API;
 
 /**
+ * {@code @ArgumentConverter} is an abtract base class for {@code @ArgumentConverter}
+ * implementations.
+ *
+ * @see org.junit.jupiter.params.converter.ArgumentConverter
  * @since 5.0
  */
 @API(Experimental)