chore: minor edits to documentation

This commit is contained in:
Rekai Nyangadzayi Musuka 2021-08-14 17:51:09 -05:00
parent 5d6df46a2d
commit 1b78b248a3
2 changed files with 4 additions and 3 deletions

View File

@ -104,10 +104,10 @@ impl Cpu {
Instruction::execute(self, instruction) Instruction::execute(self, instruction)
} }
/// Perform the [`Cpu::fetch()`] [`Cpu::decode(opcode)`] [`Cpu::execute(instr)`] /// Perform the [`Cpu::fetch()`] [`Cpu::decode()`] [`Cpu::execute()`]
/// routine. /// routine.
/// ///
/// Handle HALT state and interrupts. /// Handle HALT and interrupts.
pub fn step(&mut self) -> Cycle { pub fn step(&mut self) -> Cycle {
// Log instructions // Log instructions
// if self.reg.pc > 0xFF { // if self.reg.pc > 0xFF {

View File

@ -1531,7 +1531,8 @@ impl Instruction {
/// Set program counter to Address. /// Set program counter to Address.
/// ///
/// This is explicitly meant to emulate the exact behaviour of JP, JR RET, RETI and CALL /// This is explicitly meant to emulate the exact behaviour of [`Instruction::JP`], [`Instruction::JR`]
/// [`Instruction::RET`], [`Instruction::RETI`]
/// (4 cycles) /// (4 cycles)
fn jump(cpu: &mut Cpu, addr: u16) { fn jump(cpu: &mut Cpu, addr: u16) {
cpu.set_register_pair(RegisterPair::PC, addr); cpu.set_register_pair(RegisterPair::PC, addr);