From: Chris Duncan <chris@zoso.dev>
Date: Tue, 11 Mar 2025 20:37:19 +0000 (-0700)
Subject: Fix JSdoc parameter and comment.
X-Git-Tag: v3.1.0~9^2~16
X-Git-Url: https://zoso.dev/?a=commitdiff_plain;h=da7e2eaea3ddf26aad1b0c7c82f1dcb2c090c6d8;p=nano-pow.git

Fix JSdoc parameter and comment.
---

diff --git a/src/classes/gl.ts b/src/classes/gl.ts
index 21e5368..96349a5 100644
--- a/src/classes/gl.ts
+++ b/src/classes/gl.ts
@@ -276,11 +276,12 @@ export class NanoPowGl {
 	}
 
 	/**
-	* Reads pixels into the work buffer, checks every 4th pixel for the 'found'
-	* byte, converts the subsequent 3 pixels with the nonce byte values to a hex
-	* string, and returns the result.
+	* When a result is found by the `gl.query`, downsamples the texture to speed
+	* up the subsequent `readPixels` call, reads the pixels into the work buffer,
+	* checks every 4th pixel for the 'found' byte, converts the subsequent two
+	* pixels with the nonce byte values to a hex string, and returns the result.
 	*
-	* @param workHex - Original nonce if provided for a validation call
+	* @param {string} [workHex] - Original nonce if provided for a validation call
 	* @returns Nonce as an 8-byte (16-char) hexadecimal string
 	*/
 	static #readResult (workHex?: string): string {