minor improvement to javadoc for @OptimisticLock

hibernate · Jan 23, 2025 · 1f0e056 · 1f0e056
1 parent 7532d5e
commit 1f0e056
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 6 deletions.
diff --git a/hibernate-core/src/main/java/org/hibernate/annotations/OptimisticLock.java b/hibernate-core/src/main/java/org/hibernate/annotations/OptimisticLock.java
@@ -11,13 +11,14 @@
 
 /**
  * Specifies whether mutating the annotated attribute should trigger an increment
- * to the {@link jakarta.persistence.Version version} of the entity instance. Or,
- * if {@link OptimisticLockType#ALL} or {@link OptimisticLockType#DIRTY} are used,
- * specifies whether the attribute should be included or excluded from the list of
- * checked attributes.
+ * to the {@linkplain jakarta.persistence.Version version} of the entity instance.
+ * Or, when {@link OptimisticLockType#ALL @OptimisticLocking(type = ALL)} or
+ * {@link OptimisticLockType#DIRTY @OptimisticLocking(type = DIRTY)} is used,
+ * specifies whether the annotated attribute should be included or excluded from
+ * the list of checked attributes.
  * <p>
- * If this annotation is not present, mutating an attribute <em>does</em> cause the
- * version to be incremented.
+ * If this annotation is not present, mutating an attribute <em>does</em> cause
+ * the version to be incremented.
  *
  * @author Logi Ragnarsson
  */

diff --git a/hibernate-core/src/main/java/org/hibernate/annotations/OptimisticLocking.java b/hibernate-core/src/main/java/org/hibernate/annotations/OptimisticLocking.java
@@ -45,6 +45,7 @@
  *
  * @see org.hibernate.LockMode
  * @see jakarta.persistence.LockModeType
+ * @see OptimisticLock
  */
 @Target( TYPE )
 @Retention( RUNTIME )