chore: remove stubbed docs

yarn-project/acir-simulator/src/avm/avm_execution_environment.ts

@@ -10,31 +10,30 @@ import { Fr } from '@aztec/foundation/fields';
 // TODO(https://github.com/AztecProtocol/aztec-packages/issues/3992): gas not implemented
 export class AvmExecutionEnvironment {
   constructor(
-    /** - */
     public readonly address: AztecAddress,
-    /** - */
+
     public readonly storageAddress: AztecAddress,
-    /** - */
+
     public readonly origin: AztecAddress,
-    /** - */
+
     public readonly sender: AztecAddress,
-    /** - */
+
     public readonly portal: EthAddress,
-    /** - */
+
     public readonly feePerL1Gas: Fr,
-    /** - */
+
     public readonly feePerL2Gas: Fr,
-    /** - */
+
     public readonly feePerDaGas: Fr,
-    /** - */
+
     public readonly contractCallDepth: Fr,
-    /** - */
+
     public readonly globals: GlobalVariables,
-    /** - */
+
     public readonly isStaticCall: boolean,
-    /** - */
+
     public readonly isDelegateCall: boolean,
-    /** - */
+
     public readonly calldata: Fr[],
   ) {}
 

yarn-project/acir-simulator/src/avm/avm_machine_state.ts

@@ -15,7 +15,7 @@ export class AvmMachineState {
   private returnData: Fr[];
 
   // TODO: implement tagged memory
-  /** - */
+
   public memory: Fr[];
 
   /**
@@ -24,9 +24,8 @@ export class AvmMachineState {
    */
   public internalCallStack: number[];
 
-  /** - */
   public pc: number;
-  /** - */
+
   public callStack: number[];
 
   /**
@@ -60,7 +59,6 @@ export class AvmMachineState {
     Object.freeze(returnData);
   }
 
-  /** - */
   public getReturnData(): Fr[] {
     return this.returnData;
   }

yarn-project/acir-simulator/src/avm/avm_message_call_result.ts

@@ -4,9 +4,8 @@ import { Fr } from '@aztec/foundation/fields';
  * AVM message call result.
  */
 export class AvmMessageCallResult {
-  /** - */
   public readonly reverted: boolean;
-  /** - */
+
   public readonly revertReason: Error | undefined;
   /** .- */
   public readonly output: Fr[];

yarn-project/acir-simulator/src/avm/fixtures/index.ts

@@ -10,31 +10,30 @@ import { AvmExecutionEnvironment } from '../avm_execution_environment.js';
  * An interface that allows to override the default values of the AvmExecutionEnvironment
  */
 export interface AvmExecutionEnvironmentOverrides {
-  /** - */
   address?: AztecAddress;
-  /** - */
+
   storageAddress?: AztecAddress;
-  /** - */
+
   origin?: AztecAddress;
-  /** - */
+
   sender?: AztecAddress;
-  /** - */
+
   portal?: EthAddress;
-  /** - */
+
   feePerL1Gas?: Fr;
-  /** - */
+
   feePerL2Gas?: Fr;
-  /** - */
+
   feePerDaGas?: Fr;
-  /** - */
+
   contractCallDepth?: Fr;
-  /** - */
+
   globals?: GlobalVariables;
-  /** - */
+
   isStaticCall?: boolean;
-  /** - */
+
   isDelegateCall?: boolean;
-  /** - */
+
   calldata?: Fr[];
 }
 

yarn-project/acir-simulator/src/avm/journal/host_storage.ts

@@ -6,11 +6,10 @@ import { CommitmentsDB, PublicContractsDB, PublicStateDB } from '../../index.js'
  * A wrapper around the node dbs
  */
 export class HostStorage {
-  /** - */
   public readonly publicStateDb: PublicStateDB;
-  /** - */
+
   public readonly contractsDb: PublicContractsDB;
-  /** - */
+
   public readonly commitmentsDb: CommitmentsDB;
 
   constructor(publicStateDb: PublicStateDB, contractsDb: PublicContractsDB, commitmentsDb: CommitmentsDB) {

yarn-project/acir-simulator/src/avm/journal/journal.ts

@@ -7,11 +7,10 @@ import { HostStorage } from './host_storage.js';
  * Data held within the journal
  */
 export type JournalData = {
-  /** - */
   newCommitments: Fr[];
-  /** - */
+
   newL1Messages: Fr[];
-  /** - */
+
   newNullifiers: Fr[];
   /** contract address -\> key -\> value */
   storageWrites: Map<bigint, Map<bigint, Fr>>;

yarn-project/acir-simulator/src/avm/opcodes/arithmetic.ts

@@ -4,7 +4,6 @@ import { AvmMachineState } from '../avm_machine_state.js';
 import { AvmJournal } from '../journal/index.js';
 import { Instruction } from './instruction.js';
 
-/** -*/
 export class Add extends Instruction {
   static type: string = 'ADD';
   static numberOfOperands = 3;
@@ -24,7 +23,6 @@ export class Add extends Instruction {
   }
 }
 
-/** -*/
 export class Sub extends Instruction {
   static type: string = 'SUB';
   static numberOfOperands = 3;
@@ -44,7 +42,6 @@ export class Sub extends Instruction {
   }
 }
 
-/** -*/
 export class Mul extends Instruction {
   static type: string = 'MUL';
   static numberOfOperands = 3;
@@ -64,7 +61,6 @@ export class Mul extends Instruction {
   }
 }
 
-/** -*/
 export class Div extends Instruction {
   static type: string = 'DIV';
   static numberOfOperands = 3;

yarn-project/acir-simulator/src/avm/opcodes/bitwise.ts

@@ -4,7 +4,6 @@ import { AvmMachineState } from '../avm_machine_state.js';
 import { AvmJournal } from '../journal/index.js';
 import { Instruction } from './instruction.js';
 
-/** - */
 export class And extends Instruction {
   static type: string = 'AND';
   static numberOfOperands = 3;
@@ -24,7 +23,6 @@ export class And extends Instruction {
   }
 }
 
-/** - */
 export class Or extends Instruction {
   static type: string = 'OR';
   static numberOfOperands = 3;
@@ -44,7 +42,6 @@ export class Or extends Instruction {
   }
 }
 
-/** - */
 export class Xor extends Instruction {
   static type: string = 'XOR';
   static numberOfOperands = 3;
@@ -64,7 +61,6 @@ export class Xor extends Instruction {
   }
 }
 
-/** - */
 export class Not extends Instruction {
   static type: string = 'NOT';
   static numberOfOperands = 2;
@@ -87,7 +83,6 @@ export class Not extends Instruction {
   }
 }
 
-/** -*/
 export class Shl extends Instruction {
   static type: string = 'SHL';
   static numberOfOperands = 3;
@@ -107,7 +102,6 @@ export class Shl extends Instruction {
   }
 }
 
-/** -*/
 export class Shr extends Instruction {
   static type: string = 'SHR';
   static numberOfOperands = 3;

yarn-project/acir-simulator/src/avm/opcodes/comparators.ts

@@ -4,7 +4,6 @@ import { AvmMachineState } from '../avm_machine_state.js';
 import { AvmJournal } from '../journal/index.js';
 import { Instruction } from './instruction.js';
 
-/** -*/
 export class Eq extends Instruction {
   static type: string = 'EQ';
   static numberOfOperands = 3;
@@ -23,7 +22,7 @@ export class Eq extends Instruction {
     this.incrementPc(machineState);
   }
 }
-/** -*/
+
 export class Lt extends Instruction {
   static type: string = 'Lt';
   static numberOfOperands = 3;
@@ -43,7 +42,6 @@ export class Lt extends Instruction {
   }
 }
 
-/** -*/
 export class Lte extends Instruction {
   static type: string = 'LTE';
   static numberOfOperands = 3;

yarn-project/acir-simulator/src/avm/opcodes/control_flow.ts

@@ -2,7 +2,6 @@ import { AvmMachineState } from '../avm_machine_state.js';
 import { AvmJournal } from '../journal/index.js';
 import { Instruction } from './instruction.js';
 
-/** - */
 export class Return extends Instruction {
   static type: string = 'RETURN';
   static numberOfOperands = 2;
@@ -19,7 +18,6 @@ export class Return extends Instruction {
   }
 }
 
-/** -*/
 export class Jump extends Instruction {
   static type: string = 'JUMP';
   static numberOfOperands = 1;
@@ -33,7 +31,6 @@ export class Jump extends Instruction {
   }
 }
 
-/** -*/
 export class JumpI extends Instruction {
   static type: string = 'JUMPI';
   static numberOfOperands = 1;
@@ -53,7 +50,6 @@ export class JumpI extends Instruction {
   }
 }
 
-/** -*/
 export class InternalCall extends Instruction {
   static type: string = 'INTERNALCALL';
   static numberOfOperands = 1;
@@ -68,7 +64,6 @@ export class InternalCall extends Instruction {
   }
 }
 
-/** -*/
 export class InternalReturn extends Instruction {
   static type: string = 'INTERNALRETURN';
   static numberOfOperands = 0;

yarn-project/acir-simulator/src/avm/opcodes/instruction_set.ts

@@ -8,11 +8,9 @@ import { Opcode } from './opcodes.js';
 //import { Eq, Lt, Lte } from './comparators.js';
 import { SLoad, SStore } from './storage.js';
 
-/** - */
 type InstructionConstructor = new (...args: any[]) => Instruction;
-/** - */
+
 type InstructionConstructorAndMembers = InstructionConstructor & {
-  /** - */
   numberOfOperands: number;
 };
 

yarn-project/acir-simulator/src/avm/opcodes/memory.ts

@@ -4,7 +4,6 @@ import { AvmMachineState } from '../avm_machine_state.js';
 import { AvmJournal } from '../journal/index.js';
 import { Instruction } from './instruction.js';
 
-/** - */
 export class Set extends Instruction {
   static type: string = 'SET';
   static numberOfOperands = 2;
@@ -21,7 +20,7 @@ export class Set extends Instruction {
 }
 
 // TODO(https://github.com/AztecProtocol/aztec-packages/issues/3987): tags are not implemented yet - this will behave as a mov
-/** - */
+
 export class Cast extends Instruction {
   static type: string = 'CAST';
   static numberOfOperands = 2;
@@ -39,7 +38,6 @@ export class Cast extends Instruction {
   }
 }
 
-/** - */
 export class Mov extends Instruction {
   static type: string = 'MOV';
   static numberOfOperands = 2;
@@ -57,7 +55,6 @@ export class Mov extends Instruction {
   }
 }
 
-/** - */
 export class CMov extends Instruction {
   static type: string = 'MOV';
   static numberOfOperands = 4;
@@ -82,7 +79,6 @@ export class CMov extends Instruction {
   }
 }
 
-/** - */
 export class CalldataCopy extends Instruction {
   static type: string = 'CALLDATACOPY';
   static numberOfOperands = 3;

yarn-project/acir-simulator/src/avm/opcodes/storage.ts

@@ -3,7 +3,6 @@ import { AvmInterpreterError } from '../interpreter/interpreter.js';
 import { AvmJournal } from '../journal/journal.js';
 import { Instruction } from './instruction.js';
 
-/** - */
 export class SStore extends Instruction {
   static type: string = 'SSTORE';
   static numberOfOperands = 2;
@@ -26,7 +25,6 @@ export class SStore extends Instruction {
   }
 }
 
-/** - */
 export class SLoad extends Instruction {
   static type: string = 'SLOAD';
   static numberOfOperands = 2;