@@ -11,11 +11,18 @@ It helps you to write your scripts more quickly with hints and completions.
1111<strong >jQuery</strong > and <strong >NativeScript</strong > completions disabled by default!
1212You can enable them on Preferences -> Package Settings -> JavaScript Completions.
1313
14+ <strong >Some features could use npm!</strong >
15+
16+ In Windows you must install it! Download it from [ https://nodejs.org ] ( https://nodejs.org ) .
17+
18+ To OSX and Linux, it will be downloaded automatically with nodejs.
19+
1420Features list:
1521- <a href =" #find-javascript-description " >"Find JavaScript Description" Feature</a >
1622- <a href =" #on-hover-description " >"On Hover Description" Feature</a >
1723- <a href =" #evaluate-javascript " >"Evaluate JavaScript" Feature</a >
1824- <a href =" #can-i-use " >"Can I use?" Feature</a >
25+ - <a href =" #jsdoc " >"JSDoc" Feature</a >
1926- <a href =" #context-menu-options " >Context menu options</a >
2027
2128<h2 >Usage</h2 >
@@ -139,6 +146,48 @@ Example :
139146
140147<img src =" http://s17.postimg.org/wa4u0a7a7/Schermata_2016_09_24_alle_21_07_55.png " alt =" example #3 Can I use? Feature " >
141148
149+
150+ <h3 id =" jsdoc " >"JSDoc" Feature</h3 >
151+
152+ <strong >Supported only by Sublime Text 3</strong >
153+
154+ <strong >Requires npm</strong >
155+
156+ This feature uses [ https://github.com/jsdoc3/jsdoc ] ( https://github.com/jsdoc3/jsdoc ) to generate API documentation.
157+
158+ You can find it under <code >"JavaScript Completions Tools"</code > menu -> <code >JSDoc</code >.
159+
160+ There are 2 main menu items:
161+ - Generate Documentation
162+ - Add jsdoc-settings.json to the current project folder
163+
164+ <strong >These items can be used only with a project folder opened.</strong >
165+
166+ <code >"Generate Documentation"</code > uses the jsdoc command line to generate documentation.
167+
168+ It uses <code >jsdoc-settings.json</code > file for configuration or, alternately, it will use default configuration.
169+
170+ The options (with default values) availables are:
171+ ``` json
172+ {
173+ "jsdoc_conf_file" : " conf.json" ,
174+ "destination_folder" : " out" ,
175+ "display_symbols_access_property" : " all" ,
176+ "search_within_subdirectories" : false ,
177+ "encoding_when_reading_all_source_files" : " utf-8" ,
178+ "template_path" : " " ,
179+ "tutorials_path" : " " ,
180+ "include_symbols_marked_with_the_private_tag" : false ,
181+ "pedantic_mode" : false ,
182+ "query_string_to_parse_and_store_in_global_variable" : " "
183+ }
184+ ```
185+
186+ <code >"Add jsdoc-settings.json to the current project folder"</code > will add a <code >jsdoc-settings.json</code > file with default values to the current project folder.
187+
188+ How to use JSDoc: [ http://usejsdoc.org/ ] ( http://usejsdoc.org/ )
189+
190+
142191<h3 id =" context-menu-options " >Context menu options</h3 >
143192
144193Context menu options:
0 commit comments