From f1002682eeed2eba00524e202248aeb9c80622dd Mon Sep 17 00:00:00 2001 From: redcode Date: Thu, 1 Nov 2018 05:27:28 +0100 Subject: [PATCH] Doxygen comments. --- API/emulation/CPU/Z80.h | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/API/emulation/CPU/Z80.h b/API/emulation/CPU/Z80.h index 66143f4..7b3a68f 100644 --- a/API/emulation/CPU/Z80.h +++ b/API/emulation/CPU/Z80.h @@ -26,7 +26,12 @@ this library. If not, see . */ # include #endif -/** Z80 emulator instance object. */ +/** Z80 emulator instance object. + * @details This structure holds, among other things, the state of the CPU and + * the pointers to the callback functions needed to connect the emulator with + * your code. There is no constructor function, so you need to initialize some + * of its members before using it. Specifically the following: @c context, @c + * read, @c write, @c in, @c out, @c int_data and @c halt. */ typedef struct {