From bd776b2aa975798b9e28db98f430ffa048660c04 Mon Sep 17 00:00:00 2001
From: redcode <manuel@zxe.io>
Date: Thu, 1 Nov 2018 03:12:05 +0100
Subject: [PATCH] Doxygen comments.

---
 API/emulation/CPU/Z80.h | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/API/emulation/CPU/Z80.h b/API/emulation/CPU/Z80.h
index e903a97..d57e667 100644
--- a/API/emulation/CPU/Z80.h
+++ b/API/emulation/CPU/Z80.h
@@ -117,7 +117,9 @@ typedef struct {
 
 	/** Callback: Called when the CPU enters or exits the halt state.
 	  * @param context The value of the member @c context.
-	  * @param state @c TRUE if halted; @c FALSE otherwise. */
+	  * @param state @c TRUE if halted; @c FALSE otherwise.
+	  * @note This callback is optional and must be set to @c NULL if not
+	  * used. */
 
 	void (* halt)(void *context, zboolean state);
 } Z80;