Skip to content

Commit

Permalink
Doxygen comments.
Browse files Browse the repository at this point in the history
  • Loading branch information
redcode committed Aug 4, 2023
1 parent 785503d commit d901a97
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions API/Z80.h
Original file line number Diff line number Diff line change
Expand Up @@ -325,17 +325,15 @@ typedef struct {
* been fetched.
*
* This callback is optional and must be set to @c Z_NULL when not in
* use. It is invoked before the instruction copies the A register into
* the I register. */
* use. It is invoked before executing the instruction. */

Z80Notify ld_i_a;

/** @brief Invoked to notify that an <tt>ld r,a</tt> instruction has
* been fetched.
*
* This callback is optional and must be set to @c Z_NULL when not in
* use. It is invoked before the instruction copies the A register into
* the R register. */
* use. It is invoked before executing the instruction. */

Z80Notify ld_r_a;

Expand Down Expand Up @@ -363,10 +361,10 @@ typedef struct {
* parameter and must return the opcode to be executed instead of the
* trap. If the function returns a trap (i.e., <tt>@ref Z80_HOOK</tt>),
* the emulator will do nothing, so the trap will be fetched again
* unless the function has modified the PC register or replaced the
* trap in memory with another opcode. Also note that returning a trap
* does not revert the increment of the R register performed before
* each opcode fetch. */
* unless the function has modified <tt>@ref Z80::pc</tt> or replaced
* the trap in memory with another opcode. Also note that returning a
* trap does not revert the increment of <tt>@ref Z80::r</tt> performed
* before each opcode fetch. */

Z80Read hook;

Expand All @@ -376,10 +374,12 @@ typedef struct {
* use. Only those instructions with the @c 0xED prefix that behave the
* same as two consecutive @c nop instructions are considered illegal.
* The function receives the illegal opcode as the second parameter and
* must return the number of clock cycles taken by the instruction. At
* the time of invoking this callback, and relative to the start of the
* instruction, only the R register has been incremented (twice), so PC
* still contains the memory address of the @c 0xED prefix. */
* must return the number of clock cycles taken by the instruction.
*
* At the time of invoking this callback, and relative to the start of
* the instruction, only <tt>@ref Z80::r</tt> has been incremented
* (twice), so <tt>@ref Z80::PC</tt> still contains the memory address
* of the @c 0xED prefix. */

Z80Illegal illegal;

Expand Down

0 comments on commit d901a97

Please sign in to comment.