Skip to content
Snippets Groups Projects
Commit 977b5cab authored by Rob Swindell's avatar Rob Swindell :speech_balloon:
Browse files

A few minor JSDOC fixes.

parent 4ce69004
No related branches found
No related tags found
1 merge request!463MRC mods by Codefenix (2024-10-20)
...@@ -2784,7 +2784,7 @@ static jsSyncMethodSpec js_file_functions[] = { ...@@ -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 " "<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) " "(e.g. updating an <tt>.ini</tt> file) "
"use the <i>exists</i> property like so:<br>" "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 " "<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>" "and perform automatic retries. The lock mode is as follows:<br>"
"<tt>r&nbsp</tt> DENYWRITE - Allows other scripts to open the file for reading, but not for writing.<br>" "<tt>r&nbsp</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[] = { ...@@ -2852,7 +2852,8 @@ static jsSyncMethodSpec js_file_functions[] = {
,310 ,310
}, },
{"readln", js_readln, 0, JSTYPE_STRING, JSDOCSTR("[maxlen=<tt>512</tt>]") {"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 ,310
}, },
{"readBin", js_readbin, 0, JSTYPE_NUMBER, JSDOCSTR("[bytes=<tt>4</tt> [,count=<tt>1</tt>]") {"readBin", js_readbin, 0, JSTYPE_NUMBER, JSDOCSTR("[bytes=<tt>4</tt> [,count=<tt>1</tt>]")
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment