From 0cb7ef2746ba8253d637a2fc462c18f1e5634c48 Mon Sep 17 00:00:00 2001
From: Sean Martin <martins7@tcd.ie>
Date: Fri, 27 Sep 2024 11:29:37 +0200
Subject: [PATCH] docs: screenshot manager notes

---
 src/util/screenshot_manager.ts | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/src/util/screenshot_manager.ts b/src/util/screenshot_manager.ts
index 29c1e6937..6e5f72406 100644
--- a/src/util/screenshot_manager.ts
+++ b/src/util/screenshot_manager.ts
@@ -106,6 +106,13 @@ async function extractViewportScreenshot(
   return croppedBlob;
 }
 
+/**
+ * Manages the screenshot functionality from the viewer viewer.
+ * 
+ * Responsible for linking up the Python screenshot tool with the viewer, and handling the screenshot process.
+ * The screenshot manager provides information about updates in the screenshot process, and allows for the screenshot to be taken and saved.
+ * The screenshot UI menu listens to the signals emitted by the screenshot manager to update the UI.
+ */
 export class ScreenshotManager extends RefCounted {
   screenshotId: number = -1;
   screenshotLoadStats: ScreenshotLoadStatistics | null = null;