[hibernate-commits] Hibernate SVN: r15235 - annotations/trunk/doc/reference/en/modules.

[hibernate-commits at lists.jboss.org]

Author: epbernard
Date: 2008-09-30 14:45:18 -0400 (Tue, 30 Sep 2008)
New Revision: 15235

Modified:
   annotations/trunk/doc/reference/en/modules/entity.xml
Log:
Make documentation more clear on issues related to @TypeDef processing

Modified: annotations/trunk/doc/reference/en/modules/entity.xml
===================================================================
--- annotations/trunk/doc/reference/en/modules/entity.xml	2008-09-30 15:34:15 UTC (rev 15234)
+++ annotations/trunk/doc/reference/en/modules/entity.xml	2008-09-30 18:45:18 UTC (rev 15235)
@@ -2630,10 +2630,13 @@
 
         <para><literal>@org.hibernate.annotations.TypeDef</literal> and
         <literal>@org.hibernate.annotations.TypeDefs</literal> allows you to
-        declare type definitions. These annotations are placed at the class or
-        package level. Note that these definitions will be global for the
-        session factory (even at the class level) and that type definition has
-        to be defined before any usage.</para>
+        declare type definitions. These annotations can be placed at the class or
+        package level. Note that these definitions are be global for the
+        session factory (even when defined at the class level). Type definitions have
+        to be defined before any usage. If the typ is used on a single entity, you
+        can plance the definition on the entity itself. Otherwise, it is recommended
+        to place the definition a the package level since the entity processing order
+        is not guaranteed.</para>
 
         <programlisting>@TypeDefs(
     {