From 2434db664252cd6fcd49486ee93c9144bbaa1c27 Mon Sep 17 00:00:00 2001
From: Rob Swindell <rob@synchro.net>
Date: Thu, 30 Dec 2021 14:12:47 -0800
Subject: [PATCH] A few minor JSDOC fixes.
---
src/sbbs3/js_file.c | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/src/sbbs3/js_file.c b/src/sbbs3/js_file.c
index bda78a2c76..749153c284 100644
--- a/src/sbbs3/js_file.c
+++ b/src/sbbs3/js_file.c
@@ -2784,7 +2784,7 @@ static jsSyncMethodSpec js_file_functions[] = {
"<br><b>Note:</b> To open an existing or create a new file for both reading and writing "
"(e.g. updating an <tt>.ini</tt> file) "
"use the <i>exists</i> property like so:<br>"
- "<tt>file.open(file.exists ? 'r+':'w+');</tt>"
+ "<tt>file.open(file.exists ? 'r+':'w+');</tt><br>"
"<br><b>Note:</b> When <i>shareable</i> is false, uses nopen() which will lock the file "
"and perform automatic retries. The lock mode is as follows:<br>"
"<tt>r </tt> DENYWRITE - Allows other scripts to open the file for reading, but not for writing.<br>"
@@ -2852,7 +2852,8 @@ static jsSyncMethodSpec js_file_functions[] = {
,310
},
{"readln", js_readln, 0, JSTYPE_STRING, JSDOCSTR("[maxlen=<tt>512</tt>]")
- ,JSDOCSTR("read a line-feed terminated string, <i>maxlen</i> defaults to 512 characters")
+ ,JSDOCSTR("read a line-feed terminated string, <i>maxlen</i> defaults to 512 characters. "
+ "Returns <i>null</i> upon end of file.")
,310
},
{"readBin", js_readbin, 0, JSTYPE_NUMBER, JSDOCSTR("[bytes=<tt>4</tt> [,count=<tt>1</tt>]")
@@ -2885,7 +2886,7 @@ static jsSyncMethodSpec js_file_functions[] = {
,310
},
{"writeBin", js_writebin, 1, JSTYPE_BOOLEAN, JSDOCSTR("value(s) [,bytes=<tt>4</tt>]")
- ,JSDOCSTR("write one or more binary integers to the file, default number of <i>bytes</i> is 4 (32-bits)."
+ ,JSDOCSTR("write one or more binary integers to the file, default number of <i>bytes</i> is 4 (32-bits). "
"If value is an array, writes the entire array to the file.")
,310
},
--
GitLab