Add comment on emit_nop_n.

meskill · Jun 2, 2020 · 0878147 · 0878147
1 parent 5d94837
commit 0878147
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/lib/compiler-singlepass/src/emitter_x64.rs b/lib/compiler-singlepass/src/emitter_x64.rs
@@ -77,6 +77,9 @@ pub trait Emitter {
     fn emit_label(&mut self, label: Self::Label);
 
     fn emit_nop(&mut self);
+
+    /// A high-level assembler method. Emits an instruction sequence of length `n` that is functionally
+    /// equivalent to a `nop` instruction, without guarantee about the underlying implementation.
     fn emit_nop_n(&mut self, n: usize);
 
     fn emit_mov(&mut self, sz: Size, src: Location, dst: Location);