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

Reviewed-by: never
This commit is contained in:
Doug Simon 2024-08-06 16:37:59 +00:00
parent 53db937dd0
commit 3f8b3e5527
4 changed files with 15 additions and 4 deletions

View file

@ -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 {

View file

@ -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 {

View file

@ -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;
}

View file

@ -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 {