Doxygen comments.

2018-11-01 03:12:05 +01:00
parent e2742837b7
commit bd776b2aa9
1 changed files with 3 additions and 1 deletions
--- 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;