From d3e1eff9593501ff8677b9399e1f0625f415ec78 Mon Sep 17 00:00:00 2001 From: johannst Date: Thu, 7 Dec 2023 23:53:44 +0000 Subject: deploy: b5aea3fb5fcce31599e3d7397d5413a934132231 --- src/juicebox_asm/insn.rs.html | 44 +++++++++++++++++++++++++++++++++---------- 1 file changed, 34 insertions(+), 10 deletions(-) (limited to 'src/juicebox_asm/insn.rs.html') diff --git a/src/juicebox_asm/insn.rs.html b/src/juicebox_asm/insn.rs.html index 550a4ab..a367feb 100644 --- a/src/juicebox_asm/insn.rs.html +++ b/src/juicebox_asm/insn.rs.html @@ -59,6 +59,18 @@ 59 60 61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 
//! Trait definitions of various instructions.
 
 mod add;
@@ -73,47 +85,59 @@
 mod ret;
 mod test;
 
-pub trait Add<T, U> {
+/// Trait for [`add`](https://www.felixcloutier.com/x86/add) instruction kinds.
+pub trait Add<T, U> {
     /// Emit an add instruction.
     fn add(&mut self, op1: T, op2: U);
 }
 
-pub trait Call<T> {
+/// Trait for [`call`](https://www.felixcloutier.com/x86/call) instruction kinds.
+pub trait Call<T> {
     /// Emit a call instruction.
     fn call(&mut self, op1: T);
 }
 
-pub trait Cmp<T, U> {
-    /// Emit a compare call instruction.
+/// Trait for [`cmp`](https://www.felixcloutier.com/x86/cmp) instruction kinds.
+pub trait Cmp<T, U> {
+    /// Emit a compare instruction.
+    ///
+    /// Computes `op2 - op1` and sets the status flags in the same way as the `sub` instruction,
+    /// the result is discarded.
     fn cmp(&mut self, op1: T, op2: U);
 }
 
-pub trait Dec<T> {
+/// Trait for [`dec`](https://www.felixcloutier.com/x86/dec) instruction kinds.
+pub trait Dec<T> {
     /// Emit a decrement instruction.
     fn dec(&mut self, op1: T);
 }
 
-pub trait Jmp<T> {
+/// Trait for [`jmp`](https://www.felixcloutier.com/x86/jmp) instruction kinds.
+pub trait Jmp<T> {
     /// Emit an unconditional jump instruction.
     fn jmp(&mut self, op1: T);
 }
 
-pub trait Jnz<T> {
+/// Trait for [`jnz`](https://www.felixcloutier.com/x86/jcc) instruction kinds.
+pub trait Jnz<T> {
     /// Emit a conditional jump if not zero instruction (`ZF = 0`).
     fn jnz(&mut self, op1: T);
 }
 
-pub trait Jz<T> {
+/// Trait for [`jz`](https://www.felixcloutier.com/x86/jcc) instruction kinds.
+pub trait Jz<T> {
     /// Emit a conditional jump if zero instruction (`ZF = 1`).
     fn jz(&mut self, op1: T);
 }
 
-pub trait Mov<T, U> {
+/// Trait for [`mov`](https://www.felixcloutier.com/x86/mov) instruction kinds.
+pub trait Mov<T, U> {
     /// Emit an move instruction.
     fn mov(&mut self, op1: T, op2: U);
 }
 
-pub trait Test<T, U> {
+/// Trait for [`test`](https://www.felixcloutier.com/x86/test) instruction kinds.
+pub trait Test<T, U> {
     /// Emit a logical compare instruction.
     ///
     /// Computes the bit-wise logical AND of first operand and the second operand and sets the
-- 
cgit v1.2.3