From 2979a193f4414f48c3d4aeae4810ab1d49227664 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jo=C3=A3o=20Magalh=C3=A3es?= <joamag@gmail.com>
Date: Sun, 3 Jul 2022 13:43:47 +0100
Subject: [PATCH] docs: add new docstring
---
src/gb.rs | 3 +++
1 file changed, 3 insertions(+)
diff --git a/src/gb.rs b/src/gb.rs
index a70e2cfe..46292902 100644
--- a/src/gb.rs
+++ b/src/gb.rs
@@ -25,6 +25,9 @@ pub const BOOT_DATA: [u8; 256] = [
6, 25, 120, 134, 35, 5, 32, 251, 134, 32, 254, 62, 1, 224, 80,
];
+/// Top level structure that abstracts the usage of the
+/// Game Boy system under the Boytacean emulator.
+/// Should serve as the main entry-point API.
#[cfg_attr(feature = "wasm", wasm_bindgen)]
pub struct GameBoy {
cpu: Cpu,
--
GitLab