improve Javadoc of @ColumnTransformer

hibernate-core/src/main/java/org/hibernate/annotations/ColumnTransformer.java

@@ -5,6 +5,7 @@
  * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
  */
 package org.hibernate.annotations;
+
 import java.lang.annotation.Repeatable;
 import java.lang.annotation.Retention;
 
@@ -13,11 +14,19 @@
 import static java.lang.annotation.RetentionPolicy.RUNTIME;
 
 /**
- * Custom SQL expression used to read the value from and write a value to a column.
+ * Specifies custom SQL expressions used to read and write to a column in all generated SQL
- * Use for direct object loading/saving as well as queries.
+ * involving the annotated persistent attribute.
- * The write expression must contain exactly one '?' placeholder for the value. 
+ * <ul>
- *
+ * <li>A <code>write</code> expression must contain exactly one JDBC-style '?' placeholder.
- * For example: <code>read="decrypt(credit_card_num)" write="encrypt(?)"</code>
+ * <li>A <code>read</code> expression may not contain JDBC-style placeholders.
+ * </ul>
+ * For example:
+ * <pre>
+ * {@code @Column(name="credit_card_num")
+ * @ColumnTransformer(read="decrypt(credit_card_num)"
+ *                    write="encrypt(?)")
+ * String creditCardNumber;}
+ * </pre>
  *
  * @see ColumnTransformers
  *
@@ -28,9 +37,8 @@
 @Repeatable(ColumnTransformers.class)
 public @interface ColumnTransformer {
 	/**
-	 * (Logical) column name for which the expression is used.
+	 * The name of the mapped column, if a persistent attribute maps to multiple columns.
-	 *
+	 * Optional if a persistent attribute is mapped to a single column
-	 * This can be left out if the property is bound to a single column
 	 */
 	String forColumn() default "";
 
@@ -40,8 +48,8 @@
 	String read() default "";
 
 	/**
-	 * Custom SQL expression used to write to the column. The write expression must contain exactly
+	 * Custom SQL expression used to write to the column. The expression must contain exactly
-	 * one '?' placeholder for the value.
+	 * one JDBC-style '?' placeholder.
 	 */
 	String write() default "";
 }