From 44799b5a9cf7f4d0b9ace691cf0b56c9e053ec86 Mon Sep 17 00:00:00 2001
From: Gavin King <gavin@hibernate.org>
Date: Sun, 23 Jan 2022 18:24:55 +0100
Subject: [PATCH] improve javadoc for @DialectOverride

---
 .../org/hibernate/annotations/DialectOverride.java  | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/hibernate-core/src/main/java/org/hibernate/annotations/DialectOverride.java b/hibernate-core/src/main/java/org/hibernate/annotations/DialectOverride.java
index 224349a6cb..de20ca48d6 100644
--- a/hibernate-core/src/main/java/org/hibernate/annotations/DialectOverride.java
+++ b/hibernate-core/src/main/java/org/hibernate/annotations/DialectOverride.java
@@ -21,6 +21,19 @@ import static java.lang.annotation.RetentionPolicy.RUNTIME;
 
 /**
  * Allows certain annotations to be overridden in a given SQL {@link Dialect}.
+ * <p>
+ * For example, a {@link org.hibernate.annotations.Formula} annotation may be
+ * customized for a given {@code Dialect} using the {@link Formula} annotation.
+ * An annotation may even be customized for a specific range of <em>versions</em>
+ * of the dialect by specifying a {@link Version}.
+ * <ul>
+ *     <li>{@link Formula#dialect() dialect} specifies the SQL dialect to which
+ *         the override applies,
+ *     <li>{@link Formula#sameOrAfter() sameOrAfter} specifies that the override
+ *         applies to all versions beginning with the given version, and
+ *     <li>{@link Formula#before() before} specifies that the override applies
+ *         to all versions earlier than the given version.
+ * </ul>
  *
  * @author Gavin King
  */