HV-2022 Add a few missing javadoc comments

Author: marko-bekhta

engine/src/main/java/org/hibernate/validator/BaseHibernateValidatorConfiguration.java

@@ -40,6 +40,8 @@
  * Should not be used directly, prefer {@link HibernateValidatorConfiguration} or
  * {@link PredefinedScopeHibernateValidatorConfiguration}.
  *
+ * @param <S> The actual type of the configuration.
+ *
  * @author Emmanuel Bernard
  * @author Gunnar Morling
  * @author Kevin Pollet &lt;[email protected]&gt; (C) 2011 SERLI
@@ -75,8 +77,8 @@ public interface BaseHibernateValidatorConfiguration<S extends BaseHibernateVali
 	String ALLOW_PARALLEL_METHODS_DEFINE_PARAMETER_CONSTRAINTS = "hibernate.validator.allow_parallel_method_parameter_constraint";
 
 	/**
-	 * @deprecated planned for removal. Use hibernate.validator.constraint_mapping_contributors instead.
 	 * @since 5.2
+	 * @deprecated planned for removal. Use hibernate.validator.constraint_mapping_contributors instead.
 	 */
 	@Deprecated
 	String CONSTRAINT_MAPPING_CONTRIBUTOR = "hibernate.validator.constraint_mapping_contributor";
@@ -230,7 +232,6 @@ public interface BaseHibernateValidatorConfiguration<S extends BaseHibernateVali
 	 *
 	 * @return the default {@code ValueExtractor} implementations compliant
 	 * with the specification
-	 *
 	 * @since 6.0
 	 */
 	@Incubating
@@ -241,9 +242,7 @@ public interface BaseHibernateValidatorConfiguration<S extends BaseHibernateVali
 	 * will be added to the constraints configured via annotations and/or xml.
 	 *
 	 * @param mapping {@code ConstraintMapping} instance containing programmatic configured constraints
-	 *
 	 * @return {@code this} following the chaining method pattern
-	 *
 	 * @throws IllegalArgumentException if {@code mapping} is {@code null}
 	 */
 	S addMapping(ConstraintMapping mapping);
@@ -253,7 +252,6 @@ public interface BaseHibernateValidatorConfiguration<S extends BaseHibernateVali
 	 * will stop on the first constraint violation detected.
 	 *
 	 * @param failFast {@code true} to enable fail fast, {@code false} otherwise.
-	 *
 	 * @return {@code this} following the chaining method pattern
 	 */
 	S failFast(boolean failFast);
@@ -269,9 +267,7 @@ public interface BaseHibernateValidatorConfiguration<S extends BaseHibernateVali
 	 * last fallback through Hibernate Validator's own class loader.
 	 *
 	 * @param externalClassLoader The class loader for loading user-provided resources.
-	 *
 	 * @return {@code this} following the chaining method pattern
-	 *
 	 * @since 5.2
 	 */
 	S externalClassLoader(ClassLoader externalClassLoader);
@@ -288,9 +284,7 @@ public interface BaseHibernateValidatorConfiguration<S extends BaseHibernateVali
 	 * </pre>
 	 *
 	 * @param allow flag determining whether validation will allow overriding to alter parameter constraints.
-	 *
 	 * @return {@code this} following the chaining method pattern
-	 *
 	 * @since 5.3
 	 */
 	S allowOverridingMethodAlterParameterConstraint(boolean allow);
@@ -308,9 +302,7 @@ public interface BaseHibernateValidatorConfiguration<S extends BaseHibernateVali
 	 * </pre>
 	 *
 	 * @param allow flag determining whether validation will allow multiple cascaded validation on return values.
-	 *
 	 * @return {@code this} following the chaining method pattern
-	 *
 	 * @since 5.3
 	 */
 	S allowMultipleCascadedValidationOnReturnValues(boolean allow);
@@ -328,9 +320,7 @@ public interface BaseHibernateValidatorConfiguration<S extends BaseHibernateVali
 	 * </pre>
 	 *
 	 * @param allow flag determining whether validation will allow parameter constraints in parallel hierarchies
-	 *
 	 * @return {@code this} following the chaining method pattern
-	 *
 	 * @since 5.3
 	 */
 	S allowParallelMethodsDefineParameterConstraints(boolean allow);
@@ -344,9 +334,7 @@ public interface BaseHibernateValidatorConfiguration<S extends BaseHibernateVali
 	 *
 	 * @param enabled flag determining whether per validation call caching is enabled for {@code TraversableResolver}
 	 * results.
-	 *
 	 * @return {@code this} following the chaining method pattern
-	 *
 	 * @since 6.0.3
 	 */
 	S enableTraversableResolverResultCache(boolean enabled);
@@ -356,9 +344,7 @@ public interface BaseHibernateValidatorConfiguration<S extends BaseHibernateVali
 	 * used to evaluate script expressions for {@link ScriptAssert} and {@link ParameterScriptAssert} constraints.
 	 *
 	 * @param scriptEvaluatorFactory the {@link ScriptEvaluatorFactory} to be used
-	 *
 	 * @return {@code this} following the chaining method pattern
-	 *
 	 * @since 6.0.3
 	 */
 	@Incubating
@@ -369,9 +355,7 @@ public interface BaseHibernateValidatorConfiguration<S extends BaseHibernateVali
 	 * {@link Past}/{@link PastOrPresent} and {@link Future}/{@link FutureOrPresent}.
 	 *
 	 * @param temporalValidationTolerance the acceptable tolerance
-	 *
 	 * @return {@code this} following the chaining method pattern
-	 *
 	 * @since 6.0.5
 	 */
 	@Incubating
@@ -382,9 +366,7 @@ public interface BaseHibernateValidatorConfiguration<S extends BaseHibernateVali
 	 * times, only the payload passed last will be propagated.
 	 *
 	 * @param constraintValidatorPayload the payload passed to constraint validators
-	 *
 	 * @return {@code this} following the chaining method pattern
-	 *
 	 * @since 6.0.8
 	 */
 	@Incubating
@@ -395,9 +377,7 @@ public interface BaseHibernateValidatorConfiguration<S extends BaseHibernateVali
 	 * or not.
 	 *
 	 * @param getterPropertySelectionStrategy the {@link GetterPropertySelectionStrategy} to be used
-	 *
 	 * @return {@code this} following the chaining method pattern
-	 *
 	 * @since 6.1.0
 	 */
 	@Incubating
@@ -408,9 +388,7 @@ public interface BaseHibernateValidatorConfiguration<S extends BaseHibernateVali
 	 * when constructing a property path as the one returned by {@link ConstraintViolation#getPropertyPath()}.
 	 *
 	 * @param propertyNodeNameProvider the {@link PropertyNodeNameProvider} to be used
-	 *
 	 * @return {@code this} following the chaining method pattern
-	 *
 	 * @since 6.1.0
 	 */
 	@Incubating
@@ -458,9 +436,7 @@ default S locales(Locale... locales) {
 	 * Allows setting a locale resolver, defining how the locale will be resolved when interpolating the message of a constraint violation.
 	 *
 	 * @param localeResolver the {@link LocaleResolver} to be used
-	 *
 	 * @return {@code this} following the chaining method pattern
-	 *
 	 * @since 6.1.1
 	 */
 	@Incubating
@@ -479,7 +455,6 @@ default S locales(Locale... locales) {
 	 *
 	 * @param expressionLanguageFeatureLevel the {@link ExpressionLanguageFeatureLevel} to be used
 	 * @return {@code this} following the chaining method pattern
-	 *
 	 * @since 6.2
 	 */
 	@Incubating
@@ -492,7 +467,6 @@ default S locales(Locale... locales) {
 	 *
 	 * @param expressionLanguageFeatureLevel the {@link ExpressionLanguageFeatureLevel} to be used
 	 * @return {@code this} following the chaining method pattern
-	 *
 	 * @since 6.2
 	 */
 	@Incubating
@@ -505,7 +479,6 @@ default S locales(Locale... locales) {
 	 *
 	 * @param enabled flag determining whether validated values will be printed out into trace level logs or not.
 	 * @return {@code this} following the chaining method pattern
-	 *
 	 * @since 8.0
 	 */
 	@Incubating
@@ -517,9 +490,7 @@ default S locales(Locale... locales) {
 	 * constraints generated a violation.
 	 *
 	 * @param failFastOnPropertyViolation {@code true} to enable the skipping mode, {@code false} otherwise.
-	 *
 	 * @return {@code this} following the chaining method pattern
-	 *
 	 * @since 9.0
 	 */
 	@Incubating

engine/src/main/java/org/hibernate/validator/cfg/GenericConstraintDef.java

@@ -15,6 +15,7 @@
  * {@link GenericConstraintDef#param(String, Object)} which allows to add
  * arbitrary constraint parameters.
  *
+ * @param <A> The constraint annotation type.
  * @author Hardy Ferentschik
  * @author Gunnar Morling
  */

engine/src/main/java/org/hibernate/validator/cfg/context/Cascadable.java

@@ -10,6 +10,7 @@
  * Facet of a constraint mapping creational context which allows to mark the underlying
  * element as to be validated in a cascaded way.
  *
+ * @param <C> The concrete type of the cascadable.
  * @author Gunnar Morling
  * @author Kevin Pollet &lt;[email protected]&gt; (C) 2011 SERLI
  */

engine/src/main/java/org/hibernate/validator/cfg/context/ConstraintDefinitionContext.java

@@ -44,7 +44,6 @@ public interface ConstraintDefinitionContext<A extends Annotation> extends Const
 	/**
 	 * Allows to configure a validation implementation using a Lambda expression or method reference. Useful for simple
 	 * validations without the need for accessing constraint properties or customization of error messages etc.
-	 * <p>
 	 *
 	 * @param type The type of the value to validate
 	 * @return This context for method chaining

engine/src/main/java/org/hibernate/validator/cfg/defs/AssertFalseDef.java

@@ -11,6 +11,7 @@
 import org.hibernate.validator.cfg.ConstraintDef;
 
 /**
+ * An {@link AssertFalse} constraint definition.
  * @author Hardy Ferentschik
  */
 public class AssertFalseDef extends ConstraintDef<AssertFalseDef, AssertFalse> {

engine/src/main/java/org/hibernate/validator/cfg/defs/AssertTrueDef.java

@@ -11,6 +11,8 @@
 import org.hibernate.validator.cfg.ConstraintDef;
 
 /**
+ * An {@link AssertTrue} constraint definition.
+ *
  * @author Hardy Ferentschik
  */
 public class AssertTrueDef extends ConstraintDef<AssertTrueDef, AssertTrue> {

engine/src/main/java/org/hibernate/validator/cfg/defs/BitcoinAddressDef.java

@@ -11,6 +11,8 @@
 import org.hibernate.validator.constraints.BitcoinAddress;
 
 /**
+ * A {@link BitcoinAddress} constraint definition.
+ *
  * @author José Yoshiriro
  * @since 9.0.0
  */

engine/src/main/java/org/hibernate/validator/cfg/defs/CreditCardNumberDef.java

@@ -11,6 +11,8 @@
 import org.hibernate.validator.constraints.CreditCardNumber;
 
 /**
+ * A {@link CreditCardNumber} constraint definition.
+ *
  * @author Hardy Ferentschik
  */
 public class CreditCardNumberDef extends ConstraintDef<CreditCardNumberDef, CreditCardNumber> {

engine/src/main/java/org/hibernate/validator/cfg/defs/CurrencyDef.java

@@ -10,6 +10,8 @@
 import org.hibernate.validator.constraints.Currency;
 
 /**
+ * A {@link Currency} constraint definition.
+ *
  * @author Gunnar Morling
  */
 public class CurrencyDef extends ConstraintDef<CurrencyDef, Currency> {

engine/src/main/java/org/hibernate/validator/cfg/defs/DecimalMaxDef.java

@@ -12,6 +12,7 @@
 import org.hibernate.validator.cfg.ConstraintDef;
 
 /**
+ * A {@link DecimalMax} constraint definition.
  * @author Hardy Ferentschik
  */
 public class DecimalMaxDef extends ConstraintDef<DecimalMaxDef, DecimalMax> {