aboutsummaryrefslogtreecommitdiff
path: root/src/main/java/org
diff options
context:
space:
mode:
authorMichael Williamson <mike@zwobble.org>2025-02-05 19:04:11 +0000
committerMichael Williamson <mike@zwobble.org>2025-02-05 19:04:11 +0000
commit79c758d217d2c467e26bf65638bd22e885f2826d (patch)
treeed3d26f5c941e3174b6864c6b7982d07bd61427c /src/main/java/org
parent288b083367de95a21f4db716ca6ed15bfcd61415 (diff)
Format instruction descriptions as lists
Diffstat (limited to 'src/main/java/org')
-rw-r--r--src/main/java/org/shedlang/compiler/shid/instructions/ShidIntGreaterThan.java9
-rw-r--r--src/main/java/org/shedlang/compiler/shid/instructions/ShidIntGreaterThanOrEqual.java11
-rw-r--r--src/main/java/org/shedlang/compiler/shid/instructions/ShidIntLessThan.java9
-rw-r--r--src/main/java/org/shedlang/compiler/shid/instructions/ShidIntLessThanOrEqual.java11
-rw-r--r--src/main/java/org/shedlang/compiler/shid/instructions/ShidIntSub.java9
5 files changed, 22 insertions, 27 deletions
diff --git a/src/main/java/org/shedlang/compiler/shid/instructions/ShidIntGreaterThan.java b/src/main/java/org/shedlang/compiler/shid/instructions/ShidIntGreaterThan.java
index 9a86688c..111fa775 100644
--- a/src/main/java/org/shedlang/compiler/shid/instructions/ShidIntGreaterThan.java
+++ b/src/main/java/org/shedlang/compiler/shid/instructions/ShidIntGreaterThan.java
@@ -2,11 +2,10 @@ package org.shedlang.compiler.shid.instructions;
import org.shedlang.compiler.sources.Source;
-/**
- * Pop the right operand from the temporary value stack, then the left operand
- * from the temporary value stack, calculate whether the left operand is greater
- * than the right operand, then push the result onto the temporary value stack.
- */
+/// 1. Pop the right operand from the temporary value stack.
+/// 2. Pop the left operand from the temporary value stack.
+/// 3. Calculate whether the left operand is greater than the right operand.
+/// 4. Push the result onto the temporary value stack.
public record ShidIntGreaterThan(Source source) implements ShidInstruction {
@Override
public boolean isBlockTerminator() {
diff --git a/src/main/java/org/shedlang/compiler/shid/instructions/ShidIntGreaterThanOrEqual.java b/src/main/java/org/shedlang/compiler/shid/instructions/ShidIntGreaterThanOrEqual.java
index ed27be97..d2e9cf9c 100644
--- a/src/main/java/org/shedlang/compiler/shid/instructions/ShidIntGreaterThanOrEqual.java
+++ b/src/main/java/org/shedlang/compiler/shid/instructions/ShidIntGreaterThanOrEqual.java
@@ -2,12 +2,11 @@ package org.shedlang.compiler.shid.instructions;
import org.shedlang.compiler.sources.Source;
-/**
- * Pop the right operand from the temporary value stack, then the left operand
- * from the temporary value stack, calculate whether the left operand is greater
- * than or equal to the right operand, then push the result onto the temporary
- * value stack.
- */
+/// 1. Pop the right operand from the temporary value stack.
+/// 2. Pop the left operand from the temporary value stack.
+/// 3. Calculate whether the left operand is greater than or equal to the right
+/// operand.
+/// 4. Push the result onto the temporary value stack.
public record ShidIntGreaterThanOrEqual(Source source) implements ShidInstruction {
@Override
public boolean isBlockTerminator() {
diff --git a/src/main/java/org/shedlang/compiler/shid/instructions/ShidIntLessThan.java b/src/main/java/org/shedlang/compiler/shid/instructions/ShidIntLessThan.java
index 60dc9b75..b2077f2b 100644
--- a/src/main/java/org/shedlang/compiler/shid/instructions/ShidIntLessThan.java
+++ b/src/main/java/org/shedlang/compiler/shid/instructions/ShidIntLessThan.java
@@ -2,11 +2,10 @@ package org.shedlang.compiler.shid.instructions;
import org.shedlang.compiler.sources.Source;
-/**
- * Pop the right operand from the temporary value stack, then the left operand
- * from the temporary value stack, calculate whether the left operand is less
- * than the right operand, then push the result onto the temporary value stack.
- */
+/// 1. Pop the right operand from the temporary value stack.
+/// 2. Pop the left operand from the temporary value stack.
+/// 3. Calculate whether the left operand is less than the right operand.
+/// 4. Push the result onto the temporary value stack.
public record ShidIntLessThan(Source source) implements ShidInstruction {
@Override
public boolean isBlockTerminator() {
diff --git a/src/main/java/org/shedlang/compiler/shid/instructions/ShidIntLessThanOrEqual.java b/src/main/java/org/shedlang/compiler/shid/instructions/ShidIntLessThanOrEqual.java
index b96ca155..5c51359e 100644
--- a/src/main/java/org/shedlang/compiler/shid/instructions/ShidIntLessThanOrEqual.java
+++ b/src/main/java/org/shedlang/compiler/shid/instructions/ShidIntLessThanOrEqual.java
@@ -2,12 +2,11 @@ package org.shedlang.compiler.shid.instructions;
import org.shedlang.compiler.sources.Source;
-/**
- * Pop the right operand from the temporary value stack, then the left operand
- * from the temporary value stack, calculate whether the left operand is less
- * than or equal to the right operand, then push the result onto the temporary
- * value stack.
- */
+/// 1. Pop the right operand from the temporary value stack.
+/// 2. Pop the left operand from the temporary value stack.
+/// 3. Calculate whether the left operand is less than or equal to the right
+/// operand.
+/// 4. Push the result onto the temporary value stack.
public record ShidIntLessThanOrEqual(Source source) implements ShidInstruction {
@Override
public boolean isBlockTerminator() {
diff --git a/src/main/java/org/shedlang/compiler/shid/instructions/ShidIntSub.java b/src/main/java/org/shedlang/compiler/shid/instructions/ShidIntSub.java
index ca74cc97..63a0cd07 100644
--- a/src/main/java/org/shedlang/compiler/shid/instructions/ShidIntSub.java
+++ b/src/main/java/org/shedlang/compiler/shid/instructions/ShidIntSub.java
@@ -2,11 +2,10 @@ package org.shedlang.compiler.shid.instructions;
import org.shedlang.compiler.sources.Source;
-/**
- * Pop the right operand from the temporary value stack, then the left operand
- * from the temporary value stack, calculate the left operand minus the right
- * operand, then push the result onto the temporary value stack.
- */
+/// 1. Pop the right operand from the temporary value stack.
+/// 2. Pop the left operand from the temporary value stack.
+/// 3. Calculate the left operand minus the right operand.
+/// 4. Push the result onto the temporary value stack.
public record ShidIntSub(Source source) implements ShidInstruction {
@Override
public boolean isBlockTerminator() {