BVAL-420 JavaDoc improvements

src/main/java/javax/validation/Configuration.java

@@ -97,7 +97,7 @@ public interface Configuration<T extends Configuration<T>> {
 	 * Defines the constraint validator factory. Has priority over the configuration
 	 * based constraint factory.
 	 * <p/>
-	 * If null is passed, the default constraint validator factory is used
+	 * If {@code null} is passed, the default constraint validator factory is used
 	 * (defined in XML or the specification default).
 	 *
 	 * @param constraintValidatorFactory constraint factory implementation
@@ -109,7 +109,7 @@ public interface Configuration<T extends Configuration<T>> {
 	 * Defines the parameter name provider. Has priority over the configuration
 	 * based provider.
 	 * <p/>
-	 * If null is passed, the default parameter name provider is used
+	 * If {@code null} is passed, the default parameter name provider is used
 	 * (defined in XML or the specification default).
 	 *
 	 * @param parameterNameProvider parameter name provider implementation
@@ -160,7 +160,7 @@ public interface Configuration<T extends Configuration<T>> {
 	 * If a property with a given name is defined both via this method and in the
 	 * XML configuration, the value set programmatically has priority.
 	 * <p/>
-	 * If null is passed as a value, the value defined in XML is used. If no value
+	 * If {@code null} is passed as a value, the value defined in XML is used. If no value
 	 * is defined in XML, the property is considered unset.
 	 *
 	 * @param name property name

src/main/java/javax/validation/ConstraintValidatorContext.java

@@ -118,19 +118,19 @@ public interface ConstraintValidatorContext {
 	 * //Cross-parameter constraint on method createUser(String password, String passwordRepeat)
 	 * //Build a constraint violation on the default path + "passwordRepeat"
 	 * context.buildConstraintViolationWithTemplate("Passwords do not match")
-	 *                 .addParameterNode(1)
-	 *                 .addConstraintViolation();
+	 *             .addParameterNode(1)
+	 *             .addConstraintViolation();
 	 *
 	 * //Cross-parameter constraint on a method
 	 * //mergeAddresses(Map<String,Address> addresses, Map<String,Address> otherAddresses)
 	 * //Build a constraint violation on the default path + "otherAddresses["home"]
 	 * //i.e. the Address bean hosted in the "home" key of the "otherAddresses" map parameter
 	 * context.buildConstraintViolationWithTemplate(
 	 *         "Map entry home present in both and does not match")
-	 *                 .addParameterNode(1)
-	 *                 .addBeanNode()
-	 *                     .inIterable().atKey("home")
-	 *                 .addConstraintViolation();
+	 *             .addParameterNode(1)
+	 *             .addBeanNode()
+	 *                 .inIterable().atKey("home")
+	 *             .addConstraintViolation();
 	 *
 	 * //Cross-parameter constraint on a method
 	 * //mergeAddresses(Map<String,Address> addresses, Map<String,Address> otherAddresses)
@@ -139,10 +139,10 @@ public interface ConstraintValidatorContext {
 	 * //the "home" key of the "otherAddresses" map
 	 * context.buildConstraintViolationWithTemplate(
 	 *         "Map entry home present in both but city does not match")
-	 *                 .addParameterNode(1)
-	 *                 .addPropertyNode("city")
-	 *                     .inIterable().atKey("home")
-	 *                 .addConstraintViolation();
+	 *             .addParameterNode(1)
+	 *             .addPropertyNode("city")
+	 *                 .inIterable().atKey("home")
+	 *             .addConstraintViolation();
 	 * </pre>
 	 *
 	 * @param messageTemplate new un-interpolated constraint message

src/main/java/javax/validation/ConstraintViolation.java

@@ -123,7 +123,7 @@ public interface ConstraintViolation<T> {
 	Object getInvalidValue();
 
 	/**
-	 * Returns the onstraint metadata reported to fail.
+	 * Returns the constraint metadata reported to fail.
 	 * The returned instance is immutable.
 	 *
 	 * @return constraint metadata

src/main/java/javax/validation/ParameterNameProvider.java

@@ -37,19 +37,19 @@ public interface ParameterNameProvider {
 	 * Returns the names of the parameters of the given constructor.
 	 *
 	 * @param constructor the constructor for which the parameter names shall be
-	 *        retrieved; never null
+	 *        retrieved; never {@code null}
 	 * @return a list containing the names of the parameters of the given
-	 *         constructor; may be empty but never null
+	 *         constructor; may be empty but never {@code null}
 	 */
 	List<String> getParameterNames(Constructor<?> constructor);
 
 	/**
 	 * Returns the names of the parameters of the given method.
 	 *
 	 * @param method the method for which the parameter names shall be retrieved;
-	 *        never null
+	 *        never {@code null}
 	 * @return a list containing the names of the parameters of the given method;
-	 *         may be empty but never null
+	 *         may be empty but never {@code null}
 	 */
 	List<String> getParameterNames(Method method);
 }

src/main/java/javax/validation/TraversableResolver.java

@@ -61,7 +61,7 @@ boolean isReachable(Object traversableObject,
 	 * is marked as {@link Valid}.
 	 *
 	 * @param traversableObject object hosting {@code traversableProperty}
-	 *        or null if {@code validateValue} is called
+	 *        or {@code null} if {@code validateValue} is called
 	 * @param traversableProperty the traversable property
 	 * @param rootBeanType type of the root object passed to the Validator
 	 *        or hosting the method or constructor validated

src/main/java/javax/validation/ValidatorContext.java

@@ -70,7 +70,7 @@ public interface ValidatorContext {
 
 	/**
 	 * Defines the parameter name provider implementation used by the
-	 * {@link Validator}. If not set or if null is passed as a parameter,
+	 * {@link Validator}. If not set or if {@code null} is passed as a parameter,
 	 * the parameter name provider of the {@link ValidatorFactory} is used.
 	 *
 	 * @param parameterNameProvider parameter name provider implementation.

src/main/java/javax/validation/executable/ExecutableValidator.java

@@ -61,7 +61,7 @@ <T> Set<ConstraintViolation<T>> validateParameters(T object,
 	 * @param method the method for which the return value constraints is validated
 	 * @param returnValue the value returned by the given method
 	 * @param groups the group or list of groups targeted for validation (defaults to
-	 *        {@link Default}).
+	 *        {@link Default})
 	 * @return a set with the constraint violations caused by this validation;
 	 *         will be empty if no error occurs, but never {@code null}
 	 * @throws IllegalArgumentException if {@code null} is passed for any of the object,

src/main/java/javax/validation/metadata/ConstraintDescriptor.java

@@ -111,7 +111,7 @@ public interface ConstraintDescriptor<T extends Annotation> {
 	Set<ConstraintDescriptor<?>> getComposingConstraints();
 
 	/**
-	 * @return true if the constraint is annotated with {@link ReportAsSingleViolation}
+	 * @return {@code true} if the constraint is annotated with {@link ReportAsSingleViolation}
 	 */
 	boolean isReportAsSingleViolation();
 }

src/main/java/javax/validation/spi/ConfigurationState.java

@@ -41,7 +41,7 @@
 public interface ConfigurationState {
 
 	/**
-	 * Returns true if {@link Configuration#ignoreXmlConfiguration()} has been called.
+	 * Returns {@code true} if {@link Configuration#ignoreXmlConfiguration()} has been called.
 	 * <p/>
 	 * In this case, the {@link ValidatorFactory} must ignore
 	 * {@code META-INF/validation.xml}.