8336036: Synthetic documentation for a record's equals is incorrect f…

…or floating-point types

Reviewed-by: prappo
Backport-of: b3ef2a6

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/resources/doclets.properties

@@ -319,10 +319,12 @@ doclet.record_equals_doc.fullbody.head=\
 doclet.record_equals_doc.fullbody.tail.both=\
  Reference components are compared with \
  {@link java.util.Objects#equals(Object,Object) Objects::equals(Object,Object)}; \
- primitive components are compared with '=='.
+ primitive components are compared with the <code>compare</code> method from \
+ their corresponding wrapper classes.
 
 doclet.record_equals_doc.fullbody.tail.primitive=\
- All components in this record class are compared with '=='.
+ All components in this record class are compared with the <code>compare</code> \
+ method from their corresponding wrapper classes.
 
 doclet.record_equals_doc.fullbody.tail.reference=\
  All components in this record class are compared with \

test/langtools/jdk/javadoc/doclet/testRecordTypes/TestRecordTypes.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019, 2022, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2019, 2024, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -237,7 +237,8 @@ public record R(int r1) { }""");
                 """
                     Indicates whether some other object is "equal to" this one. The objects are equa\
                     l if the other object is of the same class and if all the record components are \
-                    equal. All components in this record class are compared with '=='.""",
+                    equal. All components in this record class are compared with the <code>compare</\
+                    code> method from their corresponding wrapper classes.""",
                 """
                     <span class="element-name">r1</span>""",
                 """
@@ -300,7 +301,8 @@ public record R(int r1) { }""");
                 """
                     Indicates whether some other object is "equal to" this one. The objects are equa\
                     l if the other object is of the same class and if all the record components are \
-                    equal. All components in this record class are compared with '=='.""",
+                    equal. All components in this record class are compared with the <code>compare</\
+                    code> method from their corresponding wrapper classes.""",
                 """
                     <span class="element-name">r1</span>""",
                 """
@@ -311,7 +313,8 @@ l if the other object is of the same class and if all the record components are
     @Test
     public void testGeneratedEqualsPrimitive(Path base) throws IOException {
         testGeneratedEquals(base, "int a, int b",
-             "All components in this record class are compared with '=='.");
+             "All components in this record class are compared with the <code>compare</code> method " +
+                     "from their corresponding wrapper classes.");
     }
 
     @Test
@@ -324,7 +327,8 @@ public void testGeneratedEqualsReference(Path base) throws IOException {
     public void testGeneratedEqualsMixed(Path base) throws IOException {
         testGeneratedEquals(base, "int a, Object b",
              "Reference components are compared with <code>Objects::equals(Object,Object)</code>; "
-             + "primitive components are compared with '=='.");
+             + "primitive components are compared with the <code>compare</code> method from their "
+             + "corresponding wrapper classes.");
     }
 
     private void testGeneratedEquals(Path base, String comps, String expect) throws IOException {