Issue filter annotations javadocs

src/main/java/com/epam/reportportal/annotations/Issue.java

@@ -51,7 +51,8 @@
 	ExternalIssue[] external() default {};
 
 	/**
-	 * For Parameterized and Dynamic tests apply current issue to specific test filtered by certain criteria.
+	 * For Parameterized and Dynamic tests select certain test for Issue applying using filters by certain criteria. Each additional filter
+	 * applies to the set of tests using logical "AND".
 	 *
 	 * @return filter list
 	 */

src/main/java/com/epam/reportportal/annotations/ParameterKey.java

@@ -21,23 +21,16 @@
 import java.lang.annotation.Target;
 
 /**
- * Used in parametrized tests. ReportPortal waiting test parameters
- * in <b>key - value</b> style. Using the annotation for method parameter
+ * Used in parametrized tests. ReportPortal waiting test parameters in <b>key - value</b> style. Using the annotation for method parameter
  * the specific <b>key</b> can be provided.
- *
- * @author Pavel Bortnik
- * @since ReportPortal Api v3.1.0
  */
-
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ ElementType.PARAMETER })
 public @interface ParameterKey {
-
 	/**
 	 * Returns parameter key value
 	 *
 	 * @return key value
 	 */
 	String value() default "";
-
 }

src/main/java/com/epam/reportportal/annotations/TestFilter.java

@@ -28,7 +28,19 @@
 @Retention(RetentionPolicy.RUNTIME)
 @Target({})
 public @interface TestFilter {
+
+	/**
+	 * Specify Test Name filters to select certain test for {@link Issue} applying, suitable for dynamic tests.
+	 *
+	 * @return Test Name filters
+	 */
 	TestNameFilter[] name() default {};
 
+
+	/**
+	 * Specify Test Parameter filters to select certain test for {@link Issue} applying, suitable for parameterized tests.
+	 *
+	 * @return Test Name filters
+	 */
 	TestParamFilter[] param() default {};
 }

src/main/java/com/epam/reportportal/annotations/TestNameFilter.java

@@ -20,7 +20,24 @@
  * Filter Test Set by Test Name.
  */
 public @interface TestNameFilter {
+	/**
+	 * Select a test which name starts with specified String.
+	 *
+	 * @return required prefix
+	 */
 	String startsWith() default "";
+
+	/**
+	 * Select a test which name ends with specified String.
+	 *
+	 * @return required postfix
+	 */
 	String endsWith() default "";
+
+	/**
+	 * Select a test which name should contain specified String.
+	 *
+	 * @return required contents
+	 */
 	String contains() default "";
 }

src/main/java/com/epam/reportportal/annotations/TestParamFilter.java

@@ -20,12 +20,58 @@
  * Filter Test Set by Parameter.
  */
 public @interface TestParamFilter {
+	/**
+	 * Parameter index to which this filter should be applied. If it's not specified then the filter try to match every parameter.
+	 *
+	 * @return parameter index
+	 */
 	int paramIndex() default -1;
+
+	/**
+	 * Select a test parameter which name starts with specified String. Designed to use with {@link ParameterKey} annotation, since there is
+	 * no parameters names in Java runtime.
+	 *
+	 * @return required prefix
+	 */
 	String nameStartsWith() default "";
+
+	/**
+	 * Select a test parameter which name ends with specified String. Designed to use with {@link ParameterKey} annotation, since there is
+	 * no parameters names in Java runtime.
+	 *
+	 * @return required prefix
+	 */
 	String nameEndsWith() default "";
+
+	/**
+	 * Select a test parameter which name should contain specified String. Designed to use with {@link ParameterKey} annotation, since there
+	 * is no parameters names in Java runtime.
+	 *
+	 * @return required prefix
+	 */
 	String nameContains() default "";
 
+	/**
+	 * Select a test parameter which value starts with specified String. Non-string parameter values convert with {@link Object#toString()},
+	 * method.
+	 *
+	 * @return required prefix
+	 */
 	String valueStartsWith() default "";
+
+	/**
+	 * Select a test parameter which value ends with specified String. Non-string parameter values convert with {@link Object#toString()},
+	 * method.
+	 *
+	 * @return required prefix
+	 */
 	String valueEndsWith() default "";
+
+	/**
+	 * Select a test parameter which value should contain specified String. Non-string parameter values convert with
+	 * {@link Object#toString()}, method.
+	 *
+	 * @return required prefix
+	 */
 	String valueContains() default "";
 }