From 11a548e1b388677927690a89dcb9bd657c312e99 Mon Sep 17 00:00:00 2001
From: Gavin King <gavin@hibernate.org>
Date: Mon, 23 May 2005 03:46:29 +0000
Subject: [PATCH] doc's comment stuff

git-svn-id: https://svn.jboss.org/repos/hibernate/trunk/Hibernate3/doc@6873 1b8cb986-b30d-0410-93ca-fae66ebed9b2
---
 reference/en/modules/toolset_guide.xml | 30 ++++++++++++++++++++++----
 1 file changed, 26 insertions(+), 4 deletions(-)

diff --git a/reference/en/modules/toolset_guide.xml b/reference/en/modules/toolset_guide.xml
index ef4d3d72a2..2c5497daaa 100644
--- a/reference/en/modules/toolset_guide.xml
+++ b/reference/en/modules/toolset_guide.xml
@@ -108,9 +108,9 @@
 
             <programlisting><![CDATA[<property name="foo" type="string">
     <column name="foo" length="64" not-null="true" sql-type="text"/>
-</property>
+</property>]]></programlisting>
 
-<property name="bar" type="my.customtypes.MultiColumnType"/>
+            <programlisting><![CDATA[<property name="bar" type="my.customtypes.MultiColumnType"/>
     <column name="fee" not-null="true" index="bar_idx"/>
     <column name="fi" not-null="true" index="bar_idx"/>
     <column name="fo" not-null="true" index="bar_idx"/>
@@ -127,9 +127,9 @@
             
             <programlisting><![CDATA[<property name="foo" type="integer">
     <column name="foo" check="foo > 10"/>
-</property>
+</property>]]></programlisting>
 
-<class name="Foo" table="foos" check="bar < 100.0">
+            <programlisting><![CDATA[<class name="Foo" table="foos" check="bar < 100.0">
     ...
     <property name="bar" type="float"/>
 </class>]]></programlisting>
@@ -203,6 +203,28 @@
                    </tbody>
                 </tgroup>
             </table>
+            
+            <para>
+                The <literal>&lt;comment&gt;</literal> element allows you to specify a comments
+                for the generated schema.
+            </para>
+            
+            <programlisting><![CDATA[<class name="Customer" table="CurCust">
+    <comment>Current customers only</comment>
+    ...
+</class>]]></programlisting>
+
+            <programlisting><![CDATA[<property name="balance">
+    <column name="bal">
+        <comment>Balance in USD</comment>
+    </column>
+</property>]]></programlisting>
+            
+            <para>
+                This results in a <literal>comment on table</literal> or 
+                <literal>comment on column</literal> statement in the generated
+                DDL (where supported).
+            </para>
 
         </sect2>