[hibernate-commits] Hibernate SVN: r14497 - search/trunk/src/java/org/hibernate/search/annotations.

[hibernate-commits at lists.jboss.org]

Author: epbernard
Date: 2008-04-07 10:54:27 -0400 (Mon, 07 Apr 2008)
New Revision: 14497

Modified:
   search/trunk/src/java/org/hibernate/search/annotations/IndexedEmbedded.java
Log:
Javadoc cleanup

Modified: search/trunk/src/java/org/hibernate/search/annotations/IndexedEmbedded.java
===================================================================
--- search/trunk/src/java/org/hibernate/search/annotations/IndexedEmbedded.java	2008-04-03 19:47:49 UTC (rev 14496)
+++ search/trunk/src/java/org/hibernate/search/annotations/IndexedEmbedded.java	2008-04-07 14:54:27 UTC (rev 14497)
@@ -11,7 +11,7 @@
 @Target( { ElementType.FIELD, ElementType.METHOD } )
 @Documented
 /**
- * Specifies that an association (@*ToOne or @Embedded) is to be indexed
+ * Specifies that an association (@*To*, @Embedded, @CollectionOfEmbedded) is to be indexed
  * in the root entity index
  * It allows queries involving associated objects restrictions
  */
@@ -25,7 +25,7 @@
 	/**
 	 * Stop indexing embedded elements when depth is reached
 	 * depth=1 means the associated element is index, but not its embedded elements
-	 * Default: infinite (an exception will be raised in case of class circular reference when infinite is chosen)
+	 * Default: infinite (an exception will be raised if a class circular reference occurs while infinite is chosen)
 	 */
 	int depth() default Integer.MAX_VALUE;