BVAL-692 JavaDoc improvements

Author: gunnarmorling

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

@@ -139,8 +139,8 @@ public interface Configuration<T extends Configuration<T>> {
 	 *
 	 * @param extractor value extractor implementation
 	 * @return {@code this} following the chaining method pattern.
-	 * @throws ValueExtractorDeclarationException If more than one extractor for
-	 *         the same type and type use is added
+	 * @throws ValueExtractorDeclarationException if more than one extractor for
+	 *         the same type and type parameter is added
 	 * @since 2.0
 	 */
 	T addValueExtractor(ValueExtractor<?> extractor);

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

@@ -350,9 +350,9 @@ LeafNodeBuilderCustomizableContext inContainer(Class<?> containerClass,
 
 		/**
 		 * Represents refinement choices for a node which is
-		 * in an {@code Iterator} or {@code Map}.
+		 * in an iterable, e.g. array, {@code Iterable} or {@code Map}.
 		 * <p>
-		 * If the iterator is an indexed collection or a map,
+		 * If the iterable is an indexed collection or a map,
 		 * the index or the key should be set.
 		 * <p>
 		 * The node is a leaf node (i.e. no subnode can be added).
@@ -567,9 +567,9 @@ ContainerElementNodeBuilderCustomizableContext addContainerElementNode(
 
 		/**
 		 * Represents refinement choices for a node which is
-		 * in an {@code Iterator} or {@code Map}.
+		 * in an iterable, e.g. array, {@code Iterable} or {@code Map}.
 		 * <p>
-		 * If the iterator is an indexed collection or a map,
+		 * If the iterable is an indexed collection or a map,
 		 * the index or the key should be set.
 		 * <p>
 		 * The node is not necessarily a leaf node (i.e. subnodes can
@@ -636,7 +636,6 @@ interface NodeContextBuilder {
 			/**
 			 * Adds a container element node to the path the {@link ConstraintViolation}
 			 * will be associated to.
-			 * Note that container element nodes are always leaf nodes.
 			 *
 			 * @param name the node name
 			 * @param containerType the type of the container
@@ -791,10 +790,9 @@ ContainerElementNodeBuilderCustomizableContext addContainerElementNode(
 		}
 
 		/**
-		 * Represents refinement choices for a container element node which is
-		 * in an {@code Iterator} or {@code Map}.
+		 * Represents refinement choices for a container element node.
 		 * <p>
-		 * If the iterator is an indexed collection or a map,
+		 * If the container is an indexed collection or a map,
 		 * the index or the key should be set.
 		 * <p>
 		 * The node is not necessarily a leaf node (i.e. subnodes can

src/main/java/javax/validation/Path.java

@@ -130,7 +130,7 @@ interface Node {
 		 *
 		 * @return this node narrowed down to the given type.
 		 *
-		 * @throws ClassCastException If this node is not assignable to the type {@code T}
+		 * @throws ClassCastException if this node is not assignable to the type {@code T}
 		 * @since 1.1
 		 */
 		<T extends Node> T as(Class<T> nodeType);

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

@@ -96,7 +96,7 @@ public interface ValidatorContext {
 	 *
 	 * @param extractor value extractor implementation
 	 * @return self following the chaining method pattern
-	 * @throws ValueExtractorDeclarationException If more than one extractor for
+	 * @throws ValueExtractorDeclarationException if more than one extractor for
 	 *         the same type and type parameter is added
 	 * @since 2.0
 	 */

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

@@ -18,7 +18,7 @@
 public interface ContainerElementTypeDescriptor extends ElementDescriptor, CascadableDescriptor, ContainerDescriptor {
 
 	/**
-	 * Returns the index of the type argument corresponding to this container element type
+	 * Returns the index of the type argument corresponding to this container element type.
 	 * @return the index of the type argument corresponding to this container element type
 	 */
 	Integer getTypeArgumentIndex();