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

Better JSDOC description of use_diz param to FileBase.add()

parent 946e42d6
No related branches found
No related tags found
1 merge request!455Update branch with changes from master
...@@ -1704,8 +1704,8 @@ static jsSyncMethodSpec js_filebase_functions[] = { ...@@ -1704,8 +1704,8 @@ static jsSyncMethodSpec js_filebase_functions[] = {
,31900 ,31900
}, },
{"add", js_add_file, 1, JSTYPE_BOOLEAN {"add", js_add_file, 1, JSTYPE_BOOLEAN
,JSDOCSTR("<i>object</i> file-meta-object [,<i>bool</i> use_diz=config] [,<i>object</i> client=none]") ,JSDOCSTR("<i>object</i> file-meta-object [,<i>bool</i> use_diz=true-if-no-extdesc] [,<i>object</i> client=none]")
,JSDOCSTR("Add a file to the file base, returning <tt>true</tt> on success or <tt>false</tt> upon failure. Pass <tt>use_diz</tt> parameter as <tt>true</tt> or <tt>false</tt> to override directory configuration with regards to extracting/using description files (e.g. FILE_ID.DIZ) from archive (e.g. ZIP) files.") ,JSDOCSTR("Add a file to the file base, returning <tt>true</tt> on success or <tt>false</tt> upon failure. Pass <tt>use_diz</tt> parameter as <tt>true</tt> or <tt>false</tt> to force or prevent the extraction/import of description file (e.g. FILE_ID.DIZ) within archive (e.g. ZIP) file.")
,31900 ,31900
}, },
{"remove", js_remove_file, 2, JSTYPE_BOOLEAN {"remove", js_remove_file, 2, JSTYPE_BOOLEAN
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment