8337887: [JVMCI] Clarify jdk.vm.ci.code.Architecture.getName javadoc

Reviewed-by: never

Author: Doug Simon

src/jdk.internal.vm.ci/share/classes/jdk/vm/ci/aarch64/AArch64.java

@@ -35,6 +35,8 @@
 
 /**
  * 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 {
 

src/jdk.internal.vm.ci/share/classes/jdk/vm/ci/amd64/AMD64.java

@@ -40,6 +40,8 @@
 
 /**
  * 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 {
 

src/jdk.internal.vm.ci/share/classes/jdk/vm/ci/code/Architecture.java

@@ -107,7 +107,7 @@ protected Architecture(String name, PlatformKind wordKind, ByteOrder byteOrder,
     /**
      * 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 PlatformKind getWordKind() {
         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;
     }

src/jdk.internal.vm.ci/share/classes/jdk/vm/ci/riscv64/RISCV64.java

@@ -35,6 +35,8 @@
 
 /**
  * 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 {