From 3e5326e0e81d2497468e238cfadbe617b54a40a1 Mon Sep 17 00:00:00 2001
From: Rob Swindell <rob@synchro.net>
Date: Sat, 15 Jan 2022 19:47:18 -0800
Subject: [PATCH] Correct JSDOCS for get_path, get_size, and get_time methods
These methods also (optionally) accept a file-meta-object as an argument.
---
src/sbbs3/js_filebase.c | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/src/sbbs3/js_filebase.c b/src/sbbs3/js_filebase.c
index 569bcbc2e0..4e518e0e2c 100644
--- a/src/sbbs3/js_filebase.c
+++ b/src/sbbs3/js_filebase.c
@@ -1642,17 +1642,17 @@ static jsSyncMethodSpec js_filebase_functions[] = {
,31900
},
{"get_path", js_get_file_path, 1, JSTYPE_STRING
- ,JSDOCSTR("filename")
+ ,JSDOCSTR("filename or file-meta-object")
,JSDOCSTR("get the full path to the local file")
,31900
},
{"get_size", js_get_file_size, 1, JSTYPE_NUMBER
- ,JSDOCSTR("filename")
+ ,JSDOCSTR("filename or file-meta-object")
,JSDOCSTR("get the size of the local file, in bytes, or -1 if it does not exist")
,31900
},
{"get_time", js_get_file_time, 1, JSTYPE_NUMBER
- ,JSDOCSTR("filename")
+ ,JSDOCSTR("filename or file-meta-object")
,JSDOCSTR("get the modification date/time stamp of the local file")
,31900
},
--
GitLab