Doxygen comments.

This commit is contained in:
redcode
2018-11-01 05:27:28 +01:00
parent 8d2bcbb115
commit f1002682ee

View File

@@ -26,7 +26,12 @@ this library. If not, see <http://www.gnu.org/licenses/>. */
# include <Z/hardware/CPU/architecture/Z80.h>
#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 {