[hibernate-commits] Hibernate SVN: r14514 - search/trunk/doc/reference/en/modules.

[hibernate-commits at lists.jboss.org]

Author: hardy.ferentschik
Date: 2008-04-18 15:14:45 -0400 (Fri, 18 Apr 2008)
New Revision: 14514

Modified:
   search/trunk/doc/reference/en/modules/getting-started.xml
   search/trunk/doc/reference/en/modules/mapping.xml
Log:
HSEARCH-180 - Documentation updates and fixes.

Modified: search/trunk/doc/reference/en/modules/getting-started.xml
===================================================================
--- search/trunk/doc/reference/en/modules/getting-started.xml	2008-04-17 23:05:11 UTC (rev 14513)
+++ search/trunk/doc/reference/en/modules/getting-started.xml	2008-04-18 19:14:45 UTC (rev 14514)
@@ -49,9 +49,14 @@
             <entry>Hibernate Annotations</entry>
 
             <entry>Even though Hibernate Search can be used without Hibernate
-            Annotations the following instructions will use them for ease of
-            use. The tutorial is tested against version 3.3.x of Hibernate
-            Annotations.</entry>
+            Annotations the following instructions will use them for basic
+            entity configuration (<emphasis>@Entity, @Id,
+            @OneToMany,...</emphasis>). This part of the configuration could
+            also be expressed in xml or code. However, Hibernate Search itself
+            has its own set of annotations (<emphasis>@Indexed, @DocumentId,
+            @Field,...</emphasis>) for which there exists so far no
+            alternative configuration. The tutorial is tested against version
+            3.3.x of Hibernate Annotations. </entry>
           </row>
         </tbody>
       </tgroup>
@@ -89,7 +94,7 @@
 &lt;dependency&gt;
    &lt;groupId&gt;org.hibernate&lt;/groupId&gt;
    &lt;artifactId&gt;hibernate-search&lt;/artifactId&gt;
-   &lt;version&gt;3.0.0.ga&lt;/version&gt;
+   &lt;version&gt;3.0.1.GA&lt;/version&gt;
 &lt;/dependency&gt;
 &lt;dependency&gt;
    &lt;groupId&gt;org.hibernate&lt;/groupId&gt;

Modified: search/trunk/doc/reference/en/modules/mapping.xml
===================================================================
--- search/trunk/doc/reference/en/modules/mapping.xml	2008-04-17 23:05:11 UTC (rev 14513)
+++ search/trunk/doc/reference/en/modules/mapping.xml	2008-04-18 19:14:45 UTC (rev 14514)
@@ -350,11 +350,11 @@
    ...
 }</programlisting>
 
-      <para>Any <literal>@*ToOne</literal> and <literal>@Embedded</literal>
-      attribute can be annotated with <literal>@IndexedEmbedded</literal>. The
-      attributes of the associated class will then be added to the main entity
-      index. In the previous example, the index will contain the following
-      fields</para>
+      <para>Any <literal>@ManyToMany, @*ToOne</literal> and
+      <literal>@Embedded</literal> attribute can be annotated with
+      <literal>@IndexedEmbedded</literal>. The attributes of the associated
+      class will then be added to the main entity index. In the previous
+      example, the index will contain the following fields</para>
 
       <itemizedlist>
         <listitem>