get rid of "NOTE :" which looks terrible in compiled javadoc

- use @implNot / @apinot instead

Author: gavinking

hibernate-core/src/main/java/org/hibernate/QueryException.java

@@ -111,9 +111,9 @@ public final QueryException wrapWithQueryString(String queryString) {
 	/**
 	 * Called from {@link #wrapWithQueryString(String)} when we really need to
 	 * generate a new {@code QueryException} (or subclass).
-	 * <p>
-	 * NOTE : implementors should take care to use {@link #getOriginalMessage()}
-	 *        for the message, not {@link #getMessage()}
+	 *
+	 * @implNote implementors should take care to use {@link #getOriginalMessage()}
+	 *           for the message, not {@link #getMessage()}
 	 *
 	 * @param queryString The query string
 	 *

hibernate-core/src/main/java/org/hibernate/SessionFactoryObserver.java

@@ -32,10 +32,10 @@ default void sessionFactoryCreated(SessionFactory factory) {
 	/**
 	 * Callback to indicate that the given factory is about to close.  The passed factory
 	 * reference should be usable since it is only about to close.
-	 * <p>
-	 * NOTE : defined as default to allow for existing SessionFactoryObserver impls to work
-	 * in 5.2.  Starting in 6.0 the default will be removed and SessionFactoryObserver impls
-	 * will be required to implement this new method.
+	 *
+	 * @apiNote defined as default to allow for existing {@code SessionFactoryObserver}
+	 *          implementations to work in 5.2. Starting in 6.0 the default will be
+	 *          removed and implementations will be required to implement this new method.
 	 *
 	 * @param factory The factory about to be closed.
 	 *

hibernate-core/src/main/java/org/hibernate/action/internal/AbstractEntityInsertAction.java

@@ -67,9 +67,10 @@ protected AbstractEntityInsertAction(
 
 	/**
 	 * Returns the entity state.
+	 * <P>
+	 * Note that the call to {@link #nullifyTransientReferencesIfNotAlready}
+	 * can modify the entity state.
 	 *
-	 * NOTE: calling {@link #nullifyTransientReferencesIfNotAlready} can modify the
-	 *       entity state.
 	 * @return the entity state.
 	 *
 	 * @see #nullifyTransientReferencesIfNotAlready

hibernate-core/src/main/java/org/hibernate/action/internal/BulkOperationCleanupAction.java

@@ -35,8 +35,8 @@
 /**
  * An {@link org.hibernate.engine.spi.ActionQueue} {@link Executable} for
  * ensuring shared cache cleanup in relation to performed bulk HQL queries.
- * <p>
- * NOTE: currently this executes for {@code INSERT} queries as well as
+ *
+ * @implNote Currently this executes for {@code INSERT} queries as well as
  * {@code UPDATE} and {@code DELETE} queries.  For {@code INSERT} it is
  * really not needed as we'd have no invalid entity/collection data to
  * clean up (we'd still need to invalidate the appropriate update-timestamps

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

@@ -38,11 +38,11 @@ enum Style {
 		 */
 		RANDOM,
 		/**
-		 * Applies a time-based generation strategy consistent with IETF RFC 4122.  Uses
-		 * IP address rather than mac address.
+		 * Applies a time-based generation strategy consistent with IETF RFC 4122.
+		 * Uses IP address rather than mac address.
 		 *
-		 * NOTE : Can be a bottleneck due to the need to synchronize in order to increment an
-		 * internal count as part of the algorithm.
+		 * @implNote Can be a bottleneck due to the need to synchronize in order
+		 *           to increment an internal count as part of the algorithm.
 		 */
 		TIME
 	}

hibernate-core/src/main/java/org/hibernate/boot/MetadataBuilder.java

@@ -142,10 +142,10 @@ public interface MetadataBuilder {
 	 * Allows specifying a specific Jandex index to use for reading annotation information.
 	 * <p>
 	 * It is <i>important</i> to understand that if a Jandex index is passed in, it is expected that
-	 * this Jandex index already contains all entries for all classes.  No additional indexing will be
+	 * this Jandex index already contains all entries for all classes. No additional indexing will be
 	 * done in this case.
-	 * <p>
-	 * NOTE : Here for future expansion.  At the moment the passed Jandex index is not used.
+	 *
+	 * @apiNote Here for future expansion. At the moment the passed Jandex index is not used.
 	 *
 	 * @param jandexView The Jandex index to use.
 	 *

hibernate-core/src/main/java/org/hibernate/boot/archive/internal/ExplodedArchiveDescriptor.java

@@ -24,7 +24,7 @@
 import static org.hibernate.internal.log.UrlMessageBundle.URL_MESSAGE_LOGGER;
 
 /**
- * Descriptor for exploded (directory) archives
+ * An {@code ArchiveDescriptor} for exploded (directory) archives.
  *
  * @author Steve Ebersole
  */

hibernate-core/src/main/java/org/hibernate/boot/archive/internal/JarFileBasedArchiveDescriptor.java

@@ -27,7 +27,7 @@
 import static org.hibernate.internal.log.UrlMessageBundle.URL_MESSAGE_LOGGER;
 
 /**
- * An ArchiveDescriptor implementation leveraging the {@link JarFile} API for processing.
+ * An {@code ArchiveDescriptor} implementation leveraging the {@link JarFile} API for processing.
  *
  * @author Steve Ebersole
  */

hibernate-core/src/main/java/org/hibernate/boot/archive/internal/JarInputStreamBasedArchiveDescriptor.java

@@ -22,8 +22,9 @@
 import static org.hibernate.internal.log.UrlMessageBundle.URL_MESSAGE_LOGGER;
 
 /**
- * An ArchiveDescriptor implementation that works on archives accessible through a {@link JarInputStream}.
- * NOTE : This is less efficient implementation than {@link JarFileBasedArchiveDescriptor}
+ * An {@code ArchiveDescriptor} that works on archives accessible through a {@link JarInputStream}.
+ *
+ * @implNote This is less efficient implementation than {@link JarFileBasedArchiveDescriptor}.
  *
  * @author Emmanuel Bernard
  * @author Steve Ebersole

hibernate-core/src/main/java/org/hibernate/boot/beanvalidation/ActivationContext.java

@@ -20,11 +20,10 @@
 public interface ActivationContext {
 	/**
 	 * Access the requested validation mode(s).
-	 * <p>
-	 * IMPL NOTE : the legacy code allowed multiple mode values to be specified, so that is why it is multi-valued here.
+	 *
+	 * @implNote The legacy code allowed multiple mode values to be specified, so that is why it is multivalued here.
 	 * However, I cannot find any good reasoning why it was defined that way and even JPA states it should be a single
-	 * value.  For 4.1 (in maintenance) I think it makes the most sense to not mess with it.  Discuss for
-	 * 4.2 and beyond.
+	 * value. For 4.1 (in maintenance) I think it makes the most sense to not mess with it.  Discuss for 4.2 and beyond.
 	 *
 	 * @return The requested validation modes
 	 */