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

[hibernate-commits at lists.jboss.org]

Author: epbernard
Date: 2008-09-30 14:58:47 -0400 (Tue, 30 Sep 2008)
New Revision: 15237

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 18:48:41 UTC (rev 15236)
+++ annotations/trunk/doc/reference/en/modules/entity.xml	2008-09-30 18:58:47 UTC (rev 15237)
@@ -2637,8 +2637,11 @@
         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>
+          <note>Package level annotations are placed in a file named <filename>package-info.java</filename>
+          in the appropriate package. Place your annotations before the package declaration.</note>
 
-        <programlisting>@TypeDefs(
+        <programlisting>//in org/hibernate/test/annotations/entity/package-info.java
+ at TypeDefs(
     {
     @TypeDef(
         name="caster",
@@ -2651,7 +2654,7 @@
 )
 package org.hibernate.test.annotations.entity;
 
-...
+//in org/hibernate/test/annotations/entity/Forest.java
 public class Forest {
     @Type(type="caster")
     public String getSmallText() {