From 99b8b33b963484f94dc6b20654b77d75428995a2 Mon Sep 17 00:00:00 2001
From: "Rob Swindell (on Windows 11)" <rob@synchro.net>
Date: Thu, 10 Apr 2025 20:01:30 -0700
Subject: [PATCH] Update JSDOC descriptions for md5_calc() and sha1_calc()
to clarify how many hex digits will be included in the returned (hex) strings
---
src/sbbs3/js_global.c | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/src/sbbs3/js_global.c b/src/sbbs3/js_global.c
index 208a0cc56e..0b5c710652 100644
--- a/src/sbbs3/js_global.c
+++ b/src/sbbs3/js_global.c
@@ -5222,10 +5222,10 @@ static jsSyncMethodSpec js_global_functions[] = {
, JSDOCSTR("Calculate and return 32-bit checksum of text string")
, 311},
{"md5_calc", js_md5_calc, 1, JSTYPE_STRING, JSDOCSTR("text [,<i>bool</i> hex=false]")
- , JSDOCSTR("Calculate and return 128-bit MD5 digest of text string, result encoded in base64 (default) or hexadecimal")
+ , JSDOCSTR("Calculate and return 128-bit MD5 digest of text string, result encoded in base64 (default) or hexadecimal (32 hex digits)")
, 311},
{"sha1_calc", js_sha1_calc, 1, JSTYPE_STRING, JSDOCSTR("text [,<i>bool</i> hex=false]")
- , JSDOCSTR("Calculate and return 160-bit SHA-1 digest of text string, result encoded in base64 (default) or hexadecimal")
+ , JSDOCSTR("Calculate and return 160-bit SHA-1 digest of text string, result encoded in base64 (default) or hexadecimal (40 hex digits)")
, 31900},
{"gethostbyname", js_resolve_ip, 1, JSTYPE_ALIAS },
{"resolve_ip", js_resolve_ip, 1, JSTYPE_STRING, JSDOCSTR("<i>string</i> hostname [,<i>bool</i> array=false]")
--
GitLab