From 3f8b3e55276336cbb814d3b746d4337678389969 Mon Sep 17 00:00:00 2001
From: Doug Simon <dnsimon@openjdk.org>
Date: Tue, 6 Aug 2024 16:37:59 +0000
Subject: [PATCH] 8337887: [JVMCI] Clarify jdk.vm.ci.code.Architecture.getName
 javadoc

Reviewed-by: never
---
 .../share/classes/jdk/vm/ci/aarch64/AArch64.java    |  2 ++
 .../share/classes/jdk/vm/ci/amd64/AMD64.java        |  2 ++
 .../share/classes/jdk/vm/ci/code/Architecture.java  | 13 +++++++++----
 .../share/classes/jdk/vm/ci/riscv64/RISCV64.java    |  2 ++
 4 files changed, 15 insertions(+), 4 deletions(-)

diff --git a/src/jdk.internal.vm.ci/share/classes/jdk/vm/ci/aarch64/AArch64.java b/src/jdk.internal.vm.ci/share/classes/jdk/vm/ci/aarch64/AArch64.java
index 609e01a8db1..c0d6c4cdb84 100644
--- a/src/jdk.internal.vm.ci/share/classes/jdk/vm/ci/aarch64/AArch64.java
+++ b/src/jdk.internal.vm.ci/share/classes/jdk/vm/ci/aarch64/AArch64.java
@@ -35,6 +35,8 @@ import jdk.vm.ci.meta.PlatformKind;
 
 /**
  * Represents the AArch64 architecture.
+ *
+ * The value returned by {@code Architecture#getName} for an instance of this class is {@code "aarch64"}.
  */
 public class AArch64 extends Architecture {
 
diff --git a/src/jdk.internal.vm.ci/share/classes/jdk/vm/ci/amd64/AMD64.java b/src/jdk.internal.vm.ci/share/classes/jdk/vm/ci/amd64/AMD64.java
index 83401fed620..f0ca7a2fc23 100644
--- a/src/jdk.internal.vm.ci/share/classes/jdk/vm/ci/amd64/AMD64.java
+++ b/src/jdk.internal.vm.ci/share/classes/jdk/vm/ci/amd64/AMD64.java
@@ -40,6 +40,8 @@ import jdk.vm.ci.meta.PlatformKind;
 
 /**
  * Represents the AMD64 architecture.
+ *
+ * The value returned by {@code Architecture#getName} for an instance of this class is {@code "AMD64"}.
  */
 public class AMD64 extends Architecture {
 
diff --git a/src/jdk.internal.vm.ci/share/classes/jdk/vm/ci/code/Architecture.java b/src/jdk.internal.vm.ci/share/classes/jdk/vm/ci/code/Architecture.java
index f14855cd6b9..64b0600674f 100644
--- a/src/jdk.internal.vm.ci/share/classes/jdk/vm/ci/code/Architecture.java
+++ b/src/jdk.internal.vm.ci/share/classes/jdk/vm/ci/code/Architecture.java
@@ -107,7 +107,7 @@ public abstract class Architecture {
     /**
      * Converts this architecture to a string.
      *
-     * @return the string representation of this architecture
+     * @return a lowercase version of {@linkplain #getName name}
      */
     @Override
     public final String toString() {
@@ -126,9 +126,14 @@ public abstract class Architecture {
         return wordKind;
     }
 
-    /**
-     * Gets the name of this architecture.
-     */
+    /// Gets the name of this architecture. The value returned for
+    /// each architecture is shown in the table below.
+    ///
+    /// | Name      | Receiver type               |
+    /// |-----------|-----------------------------|
+    /// | "aarch64" | [jdk.vm.ci.aarch64.AArch64] |
+    /// | "AMD64"   | [jdk.vm.ci.amd64.AMD64]     |
+    /// | "riscv64" | [jdk.vm.ci.riscv64.RISCV64] |
     public String getName() {
         return name;
     }
diff --git a/src/jdk.internal.vm.ci/share/classes/jdk/vm/ci/riscv64/RISCV64.java b/src/jdk.internal.vm.ci/share/classes/jdk/vm/ci/riscv64/RISCV64.java
index c06ba315a14..0a287030015 100644
--- a/src/jdk.internal.vm.ci/share/classes/jdk/vm/ci/riscv64/RISCV64.java
+++ b/src/jdk.internal.vm.ci/share/classes/jdk/vm/ci/riscv64/RISCV64.java
@@ -35,6 +35,8 @@ import jdk.vm.ci.meta.PlatformKind;
 
 /**
  * Represents the RISCV64 architecture.
+ *
+ * The value returned by {@code Architecture#getName} for an instance of this class is {@code "riscv64"}.
  */
 public class RISCV64 extends Architecture {