Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/jdk.internal.vm.ci/share/classes/jdk/vm/ci/aarch64/AArch64.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 {

Expand Down
2 changes: 2 additions & 0 deletions src/jdk.internal.vm.ci/share/classes/jdk/vm/ci/amd64/AMD64.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 {

Expand Down
13 changes: 9 additions & 4 deletions src/jdk.internal.vm.ci/share/classes/jdk/vm/ci/code/Architecture.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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() {
Expand All @@ -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
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems like a good opportunity to use the new markdown support for javadoc.

/// 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;
}
Expand Down
2 changes: 2 additions & 0 deletions src/jdk.internal.vm.ci/share/classes/jdk/vm/ci/riscv64/RISCV64.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 {

Expand Down