Doxygen comments.

This commit is contained in:
redcode
2018-11-06 06:19:51 +01:00
parent be39625735
commit 76c44ac8da

View File

@@ -139,19 +139,19 @@ Z_C_SYMBOLS_BEGIN
#endif
/** Changes the CPU power status.
* @param object A pointer to a Z80 emulator instance object.
* @param object A pointer to a Z80 instance object.
* @param state @c TRUE = power ON; @c FALSE = power OFF. */
CPU_Z80_API void z80_power(Z80 *object, zboolean state);
/** Resets the CPU.
* @details This is equivalent to a pulse in the RESET line of a real Z80.
* @param object A pointer to a Z80 emulator instance object. */
* @param object A pointer to a Z80 instance object. */
CPU_Z80_API void z80_reset(Z80 *object);
/** Runs the CPU for a given number of @p cycles.
* @param object A pointer to a Z80 emulator instance object.
* @param object A pointer to a Z80 instance object.
* @param cycles The number of cycles to be executed.
* @return The number of cycles executed.
* @note Given the fact that one Z80 instruction needs between 4 and 23 cycles
@@ -162,13 +162,13 @@ CPU_Z80_API zusize z80_run(Z80 *object, zusize cycles);
/** Performs a non-maskable interrupt (NMI).
* @details This is equivalent to a pulse in the NMI line of a real Z80.
* @param object A pointer to a Z80 emulator instance object. */
* @param object A pointer to a Z80 instance object. */
CPU_Z80_API void z80_nmi(Z80 *object);
/** Changes the state of the maskable interrupt (INT).
* @details This is equivalent to a change in the INT line of a real Z80.
* @param object A pointer to a Z80 emulator instance object.
* @param object A pointer to a Z80 instance object.
* @param state @c TRUE = line high; @c FALSE = line low. */
CPU_Z80_API void z80_int(Z80 *object, zboolean state);