From 0259daf94afd8d87b39478242bc9c78d91ea7f13 Mon Sep 17 00:00:00 2001
From: rswindell <>
Date: Fri, 12 Jan 2018 22:23:07 +0000
Subject: [PATCH] Updated JSDOC descriptions with more clarity.
---
src/sbbs3/js_console.cpp | 4 ++--
src/sbbs3/js_file.c | 3 ++-
2 files changed, 4 insertions(+), 3 deletions(-)
diff --git a/src/sbbs3/js_console.cpp b/src/sbbs3/js_console.cpp
index 954a310836..26fb72ce97 100644
--- a/src/sbbs3/js_console.cpp
+++ b/src/sbbs3/js_console.cpp
@@ -1733,8 +1733,8 @@ static jsSyncMethodSpec js_console_functions[] = {
,JSDOCSTR("get a string based on template")
,310
},
- {"ungetstr", js_ungetstr, 1, JSTYPE_VOID, JSDOCSTR("")
- ,JSDOCSTR("put a string in the keyboard buffer")
+ {"ungetstr", js_ungetstr, 1, JSTYPE_VOID, JSDOCSTR("keys")
+ ,JSDOCSTR("put a data (e.g. a string of characters) in the keyboard input buffer")
,310
},
{"yesno", js_yesno, 1, JSTYPE_BOOLEAN, JSDOCSTR("question")
diff --git a/src/sbbs3/js_file.c b/src/sbbs3/js_file.c
index e110d08056..0f3a789576 100644
--- a/src/sbbs3/js_file.c
+++ b/src/sbbs3/js_file.c
@@ -2666,7 +2666,8 @@ static jsSyncMethodSpec js_file_functions[] = {
,317
},
{"write", js_write, 1, JSTYPE_BOOLEAN, JSDOCSTR("text [,length=<i>text_length</i>]")
- ,JSDOCSTR("write a string to the file (optionally unix-to-unix or base64 decoding in the process)")
+ ,JSDOCSTR("write a string to the file (optionally unix-to-unix or base64 decoding in the process). "
+ "If the specified <i>length</i> is longer than the <i>text</i>, the remaining length will be written as NUL bytes.")
,310
},
{"writeln", js_writeln, 0, JSTYPE_BOOLEAN, JSDOCSTR("[text]")
--
GitLab