From e15c34bb121faaa19efcf711c7c70c5ab18c3a65 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jo=C3=A3o=20Magalh=C3=A3es?= <joamag@gmail.com>
Date: Fri, 11 Nov 2022 08:21:12 +0000
Subject: [PATCH] docs: more docstrings
---
examples/web/react/app.tsx | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/examples/web/react/app.tsx b/examples/web/react/app.tsx
index 0e72b11e..601b56f7 100644
--- a/examples/web/react/app.tsx
+++ b/examples/web/react/app.tsx
@@ -164,8 +164,19 @@ export interface Emulator extends ObservableI {
*/
get framerate(): number;
+ /**
+ * A dictionary that contains the register names associated
+ * with their value either as strings or numbers.
+ */
get registers(): Record<string, string | number>;
+ /**
+ * Obtains the pixel buffer for the VRAM tile at the given
+ * index.
+ *
+ * @param index The index of the tile to obtain pixel buffer.
+ * @returns The pixel buffer of the tile at the given index.
+ */
getTile(index: number): Uint8Array;
/**
--
GitLab