Doxygen comments.

This commit is contained in:
redcode
2018-10-30 20:12:55 +01:00
parent e83ff35992
commit cc7059dd95

View File

@@ -45,21 +45,21 @@ typedef struct {
zuint8 (* read)(void *context, zuint16 address);
/** Called when the CPU needs to write 8 bits to memory.
* @param context A pointer to the calling emulator instance.
* @param context The value of the member `context`.
* @param address The memory address to write.
* @param value The value to write in address. */
void (* write)(void *context, zuint16 address, zuint8 value);
/** Called when the CPU needs to read 8 bits from an I/O port.
* @param context A pointer to the calling emulator instance.
* @param context The value of the member `context`.
* @param port The number of the I/O port.
* @return The 8 bits read from the I/O port. */
zuint8 (* in)(void *context, zuint16 port);
/** Called when the CPU needs to write 8 bits to an I/O port.
* @param context A pointer to the calling emulator instance.
* @param context The value of the member `context`.
* @param port The number of the I/O port.
* @param value The value to write. */
@@ -68,14 +68,14 @@ typedef struct {
/** Called when the CPU starts executing a maskable interrupt and the
* interruption mode is 0. This callback must return the instruction
* that the CPU would read from the data bus in this case.
* @param context A pointer to the calling emulator instance.
* @param context The value of the member `context`.
* @return A 32-bit value containing the bytes of an instruction. The
* instruction must begin at the most significant byte of the value. */
zuint32 (* int_data)(void *context);
/** Called when the CPU enters or exits the halt state.
* @param context A pointer to the calling emulator instance.
* @param context The value of the member `context`.
* @param state TRUE if halted, FALSE otherwise. */
void (* halt)(void *context, zboolean state);