[hibernate-commits] Hibernate SVN: r17622 - beanvalidation/api/trunk/src/main/java/javax/validation/metadata.

[hibernate-commits at lists.jboss.org]

Author: epbernard
Date: 2009-10-05 10:23:55 -0400 (Mon, 05 Oct 2009)
New Revision: 17622

Modified:
   beanvalidation/api/trunk/src/main/java/javax/validation/metadata/ElementDescriptor.java
Log:
Enhance JavaDoc

Modified: beanvalidation/api/trunk/src/main/java/javax/validation/metadata/ElementDescriptor.java
===================================================================
--- beanvalidation/api/trunk/src/main/java/javax/validation/metadata/ElementDescriptor.java	2009-10-05 09:22:52 UTC (rev 17621)
+++ beanvalidation/api/trunk/src/main/java/javax/validation/metadata/ElementDescriptor.java	2009-10-05 14:23:55 UTC (rev 17622)
@@ -44,22 +44,21 @@
 	 * empty <code>Set</code> if none are present.
 	 *
 	 * @return <code>Set</code> of constraint descriptors for this element
-	 * @deprecated {@link #findConstraints()}
 	 */
 	Set<ConstraintDescriptor<?>> getConstraintDescriptors();
 
 	/**
-	 * Find constraints and potentially restricting to certain criteria.
+	 * Find constraints and potentially restricts them to certain criteria.
 	 *
 	 * @return ConstraintFinder object.
 	 */
 	ConstraintFinder findConstraints();
 
 	/**
-	 * Declare restrictions on how constraints are retrieved.
+	 * Declare restrictions on retrived constraints.
 	 * Restrictions are cumulative.
 	 *
-	 * A ConstraintFinder is not thread-safe. The set of matching
+	 * A <code>ConstraintFinder</code> is not thread-safe. The set of matching
 	 * <code>ConstraintDescriptor</code> is.
 	 */
 	interface ConstraintFinder {
@@ -73,7 +72,7 @@
 		 *
 		 * @param groups groups targeted
 		 *
-		 * @return <code>this</code> using the chaining method pattern
+		 * @return <code>this</code> following the chaining method pattern
 		 */
 		ConstraintFinder unorderedAndMatchingGroups(Class<?>... groups);
 
@@ -83,7 +82,7 @@
 		 * Defaults to <code>Scope.HIERARCHY</code>
 		 *
 		 * @param scope exected scope
-		 * @return <code>this</code> using the chaining method pattern
+		 * @return <code>this</code> following the chaining method pattern
 		 */
 		ConstraintFinder lookingAt(Scope scope);
 
@@ -97,7 +96,7 @@
 		 * or getters (<code>METHOD</code>)
 		 *
 		 * @param types targeted types
-		 * @return <code>this</code> using the chaining method pattern
+		 * @return <code>this</code> following the chaining method pattern
 		 */
 		ConstraintFinder declaredOn(ElementType... types);