eaw/Z80
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Doxygen comments.

Browse Source
This commit is contained in:
redcode
2022-07-09 01:32:29 +02:00
parent 4e385eae20
commit 075e8c940f
1 changed files with 14 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
API/Z80.h
View File

@@ -185,7 +185,7 @@ typedef struct {
* memory address specified by the 2nd parameter.
*
* @attention This callback is mandatory, initializing it to @c Z_NULL
* will cause the emulator to crash. */
* will cause the program to crash. */
Z80Read fetch;
@@ -196,7 +196,7 @@ typedef struct {
* memory address specified by the 2nd parameter.
*
* @attention This callback is mandatory, initializing it to @c Z_NULL
* will cause the emulator to crash. */
* will cause the program to crash. */
Z80Read read;
@@ -207,21 +207,29 @@ typedef struct {
* parameter into the memory location specified by the 2nd parameter.
*
* @attention This callback is mandatory, initializing it to @c Z_NULL
* will cause the emulator to crash. */
* will cause the program to crash. */
Z80Write write;
/** @brief Callback invoked to perform an I/O port read.
*
* The invokation of this callback indicates the beginning of an I/O
* read M-cycle. The function must return the byte read from the I/O
* port specified by the 2nd parameter.
*
* @attention This callback is mandatory, initializing it to @c Z_NULL
* will cause the emulator to crash. */
* will cause the program to crash. */
Z80Read in;
/** @brief Callback invoked to perform an I/O port write.
*
* The invokation of this callback indicates the beginning of an I/O
* write M-cycle. The function must write the value of the 3rd
* parameter to the port specified by the 2nd parameter.
*
* @attention This callback is mandatory, initializing it to @c Z_NULL
* will cause the emulator to crash. */
* will cause the program to crash. */
Z80Write out;
@@ -261,7 +269,7 @@ typedef struct {
*
* @attention This callback becomes mandatory when the @c Z80.inta
* callback is used. Initializing it to @c Z_NULL will cause the
* emulator to crash. */
* program to crash. */
Z80Read int_fetch;