From bbfa014d1a4ab8bad459a5bc12e9b6c06ad5e7d0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jo=C3=A3o=20Magalh=C3=A3es?= <joamag@gmail.com>
Date: Sun, 30 Oct 2022 12:07:26 +0000
Subject: [PATCH] docs: more docs
---
examples/web/index.ts | 4 ----
examples/web/react/app.tsx | 26 ++++++++++++++++++++++++++
2 files changed, 26 insertions(+), 4 deletions(-)
diff --git a/examples/web/index.ts b/examples/web/index.ts
index 6f37cdaa..cd5b0100 100644
--- a/examples/web/index.ts
+++ b/examples/web/index.ts
@@ -891,10 +891,6 @@ class GameboyEmulator extends Observable implements Emulator {
span.textContent = "Pause";
}
- /**
- * Resets the emulator machine to the start state and loads
- * the ROM that is currently set in the emulator.
- */
reset() {
this.boot({ engine: null });
}
diff --git a/examples/web/react/app.tsx b/examples/web/react/app.tsx
index 3640ebfe..723b2950 100644
--- a/examples/web/react/app.tsx
+++ b/examples/web/react/app.tsx
@@ -66,8 +66,29 @@ export interface ObservableI {
* Should allow typical hardware operations to be performed.
*/
export interface Emulator extends ObservableI {
+ /**
+ * Obtains the descriptive name of the emulator.
+ *
+ * @returns The descriptive name of the emulator.
+ */
getName(): string;
+
+ /**
+ * Obtains a semantic version string for the current
+ * version of the emulator.
+ *
+ * @returns The semantic version string.
+ * @see {@link https://semver.org}
+ */
getVersion(): string;
+
+ /**
+ * Obtains a URL to the page describing the current version
+ * of the emulator.
+ *
+ * @returns A URL to the page describing the current version
+ * of the emulator.
+ */
getVersionUrl(): string;
/**
@@ -117,6 +138,11 @@ export interface Emulator extends ObservableI {
toggleRunning(): void;
pause(): void;
resume(): void;
+
+ /**
+ * Resets the emulator machine to the start state and
+ * re-loads the ROM that is currently set in the emulator.
+ */
reset(): void;
}
--
GitLab