improve readability of javadoc

Signed-off-by: Lukas Jungmann <lukas.jungmann@oracle.com>

foundation/org.eclipse.persistence.core/src/main/java/org/eclipse/persistence/annotations/ChangeTracking.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1998, 2023 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1998, 2024 Oracle and/or its affiliates. All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
@@ -26,7 +26,7 @@
  * org.eclipse.persistence.descriptors.changetracking.ObjectChangePolicy
  * which computes changes sets for EclipseLink's UnitOfWork commit process.
  * An ObjectChangePolicy is stored on an Entity's descriptor.
- *
+ * <p>
  * A ChangeTracking annotation may be specified on an Entity,
  * MappedSuperclass or Embeddable.
  *

foundation/org.eclipse.persistence.core/src/main/java/org/eclipse/persistence/annotations/CloneCopyPolicy.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1998, 2023 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1998, 2024 Oracle and/or its affiliates. All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
@@ -26,26 +26,26 @@
  * org.eclipse.persistence.descriptors.copying.CloneCopyPolicy on an Entity.
  * A CloneCopyPolicy must specify at one or both of the "method" or
  * "workingCopyMethod".
- *
+ * <p>
  * "workingCopyMethod" is used to clone objects that will be returned to the
  * user as they are registered in EclipseLink's transactional mechanism, the
  * UnitOfWork.
- *
+ * <p>
  * "method" will be used for the clone that is used for comparison in
  * conjunction with EclipseLink's DeferredChangeDetectionPolicy
- *
+ * <p>
  * A CloneCopyPolicy should be specified on an Entity, MappedSuperclass or
  * Embeddable.
- *
+ * <p>
  * Example:
  * {@literal @}Entity
  * {@literal @}CloneCopyPolicy(method="myCloneMethod")
- *
+ * <p>
  * or:
- *
+ * <p>
  * {@literal @}Entity
  * {@literal @}CloneCopyPolicy(method="myCloneMethod", workingCopyMethod="myWorkingCopyCloneMethod")
- *
+ * <p>
  * or:
  * {@literal @}Entity
  * {@literal @}CloneCopyPolicy(workingCopyMethodName="myWorkingCopyClone")

foundation/org.eclipse.persistence.core/src/main/java/org/eclipse/persistence/annotations/Converter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1998, 2023 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1998, 2024 Oracle and/or its affiliates. All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
@@ -31,11 +31,11 @@
  * into the database. This annotation allows developers to define a named
  * converter that can be used in their mappings. A converter can be defined on
  * an entity class, method, or field.
- *
+ * <p>
  * A Converter must be be uniquely identified by name and can be defined at
  * the class, field and property level and can be specified within an Entity,
  * MappedSuperclass and Embeddable class.
- *
+ * <p>
  * The usage of a Converter is always specified via the Convert annotation and
  * is supported on a Basic, or ElementCollection mapping.
  *

foundation/org.eclipse.persistence.core/src/main/java/org/eclipse/persistence/annotations/CopyPolicy.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1998, 2023 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1998, 2024 Oracle and/or its affiliates. All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
@@ -27,10 +27,10 @@
  * It is required that a class that
  * implements org.eclipse.persistence.descriptors.copying.CopyPolicy
  * be specified as the argument.
- *
+ * <p>
  * A CopyPolicy should be specified on an Entity, MappedSuperclass or
  * Embeddable.
- *
+ * <p>
  * For instance:
  * {@literal @}Entity
  * {@literal @}CopyPolicy("example.MyCopyPolicy")

foundation/org.eclipse.persistence.core/src/main/java/org/eclipse/persistence/annotations/Customizer.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1998, 2021 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1998, 2024 Oracle and/or its affiliates. All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
@@ -25,7 +25,7 @@
  * org.eclipse.persistence.config.DescriptorCustomizer
  * interface and is to run against an entity's class descriptor after all
  * metadata processing has been completed.
- *
+ * <p>
  * The Customizer annotation may be defined on an Entity, MappedSuperclass or
  * Embeddable class. In the case of inheritance, a Customizer is not inherited
  * from its parent classes.

foundation/org.eclipse.persistence.core/src/main/java/org/eclipse/persistence/annotations/DeleteAll.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011, 2023 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2011, 2024 Oracle and/or its affiliates. All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
@@ -27,7 +27,7 @@
  * is deleted, it should use a delete all query.  This typically happens if the
  * relationship is PrivateOwned and its owner is deleted.  In that case, the members
  * of the relationship will be deleted without reading them in.
- *
+ * <p>
  * Use this annotation with caution.  EclipseLink will not validate for you whether the
  * target entity is mapped in such a way as to allow the delete all to work.
  */

foundation/org.eclipse.persistence.core/src/main/java/org/eclipse/persistence/annotations/ExcludeDefaultMappings.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011, 2023 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2011, 2024 Oracle and/or its affiliates. All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
@@ -24,7 +24,7 @@
 /**
  * Specifies default mappings (those that are not explicitly decorated in XML or
  * using annotations)should be omitted.
- *
+ * <p>
  * An ExcludeDefaultMappings annotation can be specified on an entity,
  * embeddable or mapped superclass and applies solely to the mappings
  * of the class it is defined on.

foundation/org.eclipse.persistence.core/src/main/java/org/eclipse/persistence/annotations/ExistenceChecking.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1998, 2023 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1998, 2024 Oracle and/or its affiliates. All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
@@ -28,7 +28,7 @@
  * It is specifically used on a merge() operation to determine if only the cache
  * should be used to determine if an object exists, or the object should
  * be read (from the database or cache).  By default the object is read.
- *
+ * <p>
  * An existence-checking specification is supported on an Entity or
  * MappedSuperclass annotation.
  *

foundation/org.eclipse.persistence.core/src/main/java/org/eclipse/persistence/annotations/FetchAttribute.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011, 2020 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2011, 2024 Oracle and/or its affiliates. All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
@@ -28,11 +28,11 @@
  * attribute first occurs. It avoids the wasteful practice of loading up all
  * data of the object's attributes, in which the user is interested in only
  * partial of them.
- *
+ * <p>
  * A great deal of caution and careful system use case analysis should be use
  * when using the fetch group feature, as the extra round-trip would well offset
  * the gain from the deferred loading in many cases.
- *
+ * <p>
  * EclipseLink fetch group support is twofold: the pre-defined fetch groups at
  * the Entity or MappedSuperclass level; and dynamic (use case) fetch groups at
  * the query level.

foundation/org.eclipse.persistence.core/src/main/java/org/eclipse/persistence/annotations/FetchGroup.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011, 2023 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2011, 2024 Oracle and/or its affiliates. All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
@@ -31,15 +31,15 @@
  * access call for the attribute first occurs. It avoids the wasteful practice
  * of loading up all data of the object's attributes, in which the user is
  * interested in only partial of them.
- *
+ * <p>
  * A great deal of caution and careful system use case analysis should be use
  * when using the fetch group feature, as the extra round-trip would well offset
  * the gain from the deferred loading in many cases.
- *
+ * <p>
  * EclipseLink fetch group support is twofold: the pre-defined fetch groups at
  * the Entity or MappedSuperclass level; and dynamic (use case) fetch groups at
  * the query level.
- *
+ * <p>
  * Fetch groups can only be used when weaving is enabled or when individual
  * classes that define them explicitly implement the
  * org.eclipse.persistence.queries.FetchGroupTracker interface.

foundation/org.eclipse.persistence.core/src/main/java/org/eclipse/persistence/annotations/InstantiationCopyPolicy.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1998, 2023 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1998, 2024 Oracle and/or its affiliates. All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
@@ -25,12 +25,12 @@
  * An InstantiationCopyPolicy is used to set an
  * org.eclipse.persistence.descriptors.copying.InstantiationCopyPolicy on an
  * Entity.
- *
+ * <p>
  * InstantiationCopyPolicy is the default CopyPolicy if weaving is not used,
  * or if property access is used.
- *
+ * <p>
  * A special CloneCopyPolicy is used if weaving and field access is used.
- *
+ * <p>
  * An InstantiationCopyPolicy should be specified on an Entity,
  * MappedSuperclass or Embeddable.
  * <p>

foundation/org.eclipse.persistence.core/src/main/java/org/eclipse/persistence/annotations/MapKeyConvert.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1998, 2020 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1998, 2024 Oracle and/or its affiliates. All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
@@ -39,7 +39,7 @@
  *  - none - Will place no converter on the associated mapping. This can be used
  *  to override a situation where either another converter is defaulted or
  *  another converter is set.
- *
+ * <p>
  *  When these reserved converters are not used, it is necessary to define a
  *  converter to use using the @Converter annotation.
  *

foundation/org.eclipse.persistence.core/src/main/java/org/eclipse/persistence/annotations/Multitenant.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011, 2023 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2011, 2024 Oracle and/or its affiliates. All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
@@ -27,7 +27,7 @@
  * Multitenant specifies that a given entity is shared amongst multiple tenants
  * of a given application. The multitenant type specifies how the data for these
  * entities are to be stored on the database for each tenant.
- *
+ * <p>
  * Multitenant can be specified at the Entity or MappedSuperclass level.
  *
  * @see org.eclipse.persistence.annotations.MultitenantType

foundation/org.eclipse.persistence.core/src/main/java/org/eclipse/persistence/annotations/NamedStoredFunctionQuery.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011, 2023 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2011, 2024 Oracle and/or its affiliates. All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
@@ -28,7 +28,7 @@
 /**
  * A NamedStoredFunctionQuery annotation allows the definition of queries that
  * call stored functions as named queries.
- *
+ * <p>
  * A NamedStoredFunctionQuery annotation may be defined on an Entity or
  * MappedSuperclass.
  *

foundation/org.eclipse.persistence.core/src/main/java/org/eclipse/persistence/annotations/NamedStoredProcedureQuery.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1998, 2023 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1998, 2024 Oracle and/or its affiliates. All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
@@ -30,7 +30,7 @@
 /**
  * A NamedStoredProcedureQuery annotation allows the definition of queries that
  * call stored procedures as named queries.
- *
+ * <p>
  * A NamedStoredProcedureQuery annotation may be defined on an Entity or
  * MappedSuperclass.
  *

foundation/org.eclipse.persistence.core/src/main/java/org/eclipse/persistence/annotations/Noncacheable.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011, 2023 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2011, 2024 Oracle and/or its affiliates. All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
@@ -26,7 +26,7 @@
  * relationships. If this annotation is set on a relationship that relationship
  * will not be cached even though the parent Entity may be cached. Each time the
  * Entity is retrieved the relationship will be reloaded from the data-source.
- *
+ * <p>
  * This may be useful for situations where caching of relationships is not
  * desired or when using different EclipseLink IdentityMap types and having
  * cached references extends the cache lifetime of related Entities using a

foundation/org.eclipse.persistence.core/src/main/java/org/eclipse/persistence/annotations/ObjectTypeConverter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1998, 2023 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1998, 2024 Oracle and/or its affiliates. All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
@@ -30,11 +30,11 @@
  * org.eclipse.persistence.mappings.converters.ObjectTypeConverter that converts a fixed
  * number of database data value(s) to Java object value(s) during the reading
  * and writing of a mapped attribute
- *
+ * <p>
  * An ObjectTypeConverter must be be uniquely identified by name and can be
  * defined at the class, field and property level and can be specified within
  * an Entity, MappedSuperclass and Embeddable class.
- *
+ * <p>
  * The usage of an ObjectTypeConverter is specified via the Convert annotation
  * and is supported on a Basic, or ElementCollection mapping.
  *

foundation/org.eclipse.persistence.core/src/main/java/org/eclipse/persistence/annotations/OptimisticLocking.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1998, 2023 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1998, 2024 Oracle and/or its affiliates. All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
@@ -26,7 +26,7 @@
 /**
  * The OptimisticLocking annotation is used to specify the type of optimistic
  * locking TopLink should use when updating or deleting entities.
- *
+ * <p>
  * An optimistic-locking specification is supported on an Entity or
  * MappedSuperclass annotation.
  *

foundation/org.eclipse.persistence.core/src/main/java/org/eclipse/persistence/annotations/OrderCorrection.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1998, 2023 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1998, 2024 Oracle and/or its affiliates. All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
@@ -28,7 +28,7 @@
  * the order list read from the data base is invalid
  * (has nulls, duplicates, negative values, values greater/equal to list size -
  * the only valid order list of n elements is: {0, 1,..., n-1}).
- *
+ * <p>
  * If the annotation is not specified than OrderCorrectionValue.READ_WRITE used.
  *
  * @see "org.eclipse.persistence.jpa.config.OrderColumn"

foundation/org.eclipse.persistence.core/src/main/java/org/eclipse/persistence/annotations/OrderCorrectionType.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1998, 2020 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1998, 2024 Oracle and/or its affiliates. All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
@@ -21,7 +21,7 @@
  * OrderCorrectionType defines a strategy taken in case the order list read from the data base is invalid
  * (has nulls, duplicates, negative values, values greater/equal to list size -
  * the only valid order list of n elements is: {0, 1,..., n-1}).
- *
+ * <p>
  * OrderCorrectionType also could be set directly into CollectionMapping
  * using setListOrderCorrectionType method.
  *

foundation/org.eclipse.persistence.core/src/main/java/org/eclipse/persistence/annotations/PrivateOwned.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1998, 2020 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1998, 2024 Oracle and/or its affiliates. All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
@@ -29,7 +29,7 @@
  * cascaded across the relationship, including, deletion, insertion, refreshing,
  * locking (when cascaded). It also ensures that private objects removed from
  * collections are deleted and object added are inserted.
- *
+ * <p>
  * A PrivateOwned annotation can be used in conjunction with a OneToOne,
  * OneToMany and VariableOneToOne annotation. Private ownership is implied
  * with the BasicCollection and BasicMap annotation.