QuickDocsJS

by Ole Kröger for brackets >=0.23 
Inline short documentation for JavaScript functions, including a summary,syntax and parameters. Docs for jQuery,NodeJS and some basic ReactJS functions.
version
1.6.9
modified
2015-10-22T12:54:18.722Z
first seen
2014-03-06T12:02:07.109Z
downloads
121896
 Versions
1.6.9
2015-10-22T12:54:18.722Z
30093
1.6.8
2015-09-30T17:01:36.017Z
5241
1.6.7
2015-08-14T17:25:28.011Z
7269
1.6.6
2015-05-21T20:10:42.024Z
10432
1.6.5
2015-03-31T06:01:11.496Z
8538
1.6.4
2014-12-26T17:01:38.351Z
10414
1.6.3
2014-12-18T10:57:11.803Z
2617
1.6.2
2014-12-15T14:13:21.285Z
1504
1.6.1
2014-12-15T08:11:41.132Z
422
1.6.0
2014-11-09T18:18:29.794Z
5304
1.5.1
2014-10-28T13:55:39.045Z
3972
1.5.0
2014-10-23T13:18:49.220Z
1958
1.4.10
2014-10-15T20:31:01.050Z
1792
1.4.9
2014-10-08T08:15:14.790Z
2334
1.4.8
2014-10-06T14:00:52.430Z
1211
1.4.7
2014-09-28T20:56:31.776Z
2234
1.4.6
2014-09-06T19:56:18.656Z
3041
1.4.5
2014-08-15T13:45:47.474Z
3141
1.4.4
2014-08-14T20:12:28.718Z
752
1.4.3
2014-08-14T19:30:36.673Z
168
1.4.2
2014-08-14T14:51:43.039Z
422
1.4.1
2014-08-14T12:21:21.210Z
340
1.4.0
2014-08-13T14:24:09.586Z
781
1.3.7
2014-08-12T22:01:31.183Z
403
1.3.6
2014-08-12T18:56:34.143Z
145
1.3.5
2014-06-17T18:21:17.411Z
4348
1.3.4
2014-06-17T18:02:34.409Z
16
1.3.3
2014-06-13T15:24:02.525Z
1127
1.3.2
2014-06-13T13:18:05.613Z
140
1.3.1
2014-06-07T12:50:21.266Z
1376
1.3.0
2014-06-06T12:36:36.117Z
466
1.2.8
2014-05-31T12:37:47.886Z
1338
1.2.7
2014-04-25T11:05:51.504Z
2786
1.2.6
2014-03-25T14:34:14.883Z
2617
1.2.5
2014-03-24T09:16:13.989Z
413
1.2.4
2014-03-17T16:56:50.411Z
902
1.2.3
2014-03-12T11:20:12.724Z
776
1.2.2
2014-03-11T09:39:54.123Z
257
1.2.1
2014-03-08T19:23:49.836Z
425
1.2.0
2014-03-07T14:35:17.172Z
171
1.1.4
2014-03-06T12:09:25.708Z
200
1.1.3
2014-03-06T12:02:07.109Z
10
 Readme
# QuickDocsJS This extension provides a quick documentation for each JavaScript function. It supports JSDoc comments since v1.2 and some requirejs stuff (v1.4) which allows you to access documentations which aren't in the same file! You don't use normal JS but jQuery or NodeJS? QuickDocs supports both of them (v1.5 & v1.6). **Miss some docs for standard functions or JS extensions like jQuery? Add them here [issue (#12)](../../issues/12). Thanks for your help!** QuickDocsJS makes it easy to read your JSDoc comments inline, but you have to write these comments... ...Maybe you want to check out my [FuncDocr](https://github.com/Wikunia/brackets-FuncDocr) extension to generate JSDocs for your own functions. ## You're rich? You don't need a second yacht and have some coins to spend? Here I am :) [![Flattr this git repo](http://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=Wikunia&url=https://github.com/Wikunia/brackets-QuickDocsJS&title=Brackets-QuickDocsJS&language=javascript&tags=github&category=software) [![Donate! :3](https://www.paypalobjects.com/en_US/GB/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=B5VQXWCZXYN2W) ## Type Recognition Magic The extension tries to get the correct documentation if the function is available for strings and arrays. ```javascript var abc = 'abc'; var pos = abc.indexOf('a'); // the documentation for String.indexOf var parts = abc.split(''); pos = parts.indexOf('a'); // the documentation for Array.indexOf ``` ## How to use You can use the Navigation menu or ```Ctrl+K``` (Windows) or ```CMD+K``` (Mac), while your cursor is on a JavaScript function, to open the inline documentation. ![Example](image/example.png?raw=true) This extension uses the documentation from [http://developer.mozilla.org](http://developer.mozilla.org) for JS functions and [http://nodejs.org](http://nodejs.org) for NodeJS functions. Since v1.6.0 QuickDocs supports jQuery! Thanks [http://api.jquery.com](http://api.jquery.com) ## v 1.6.0 Support for jQuery! ![jQuery](image/jQuery.png?raw=true) `@link`-tags are parsed as HTML links now and you can use them to jump easy between functions! ## v 1.5.0 Support for NodeJS! ![NodeJS](image/nodeJS.png?raw=true) ## v 1.4.1 QuickDocsJS can use require.js `define` statements to get docs by reading other modules. [#8](../../issues/8) ## v 1.4 QuickDocsJS supports prototype functions: ```javascript /** * split a string into an array with limit entries * The last entry contains the last part of the string, which can contain the separator) * @param {String} separator string separator * @param {Integer} limit number of entries in the array * @return {Array} array of separated strings */ String.prototype.splitLimit = function(separator,limit) { var splitString = this; var result = []; var pos = splitString.search(separator); if (pos < 0) return false; result.push(splitString.substring(0,pos)); result.push(splitString.substring(pos+1)); return result; } ``` ## v 1.2 It's now possible to get documentations for your own functions using JSDoc. ``` /** get the type of a variable @param {String} content content of document @param {String} variable name of the variable @returns {String} type of the variable: unknown,String,Array or RegExp */ function getVariableType (content, variable) { ``` ![User functions](image/user_func.png?raw=true) ##Languages + English ### License Creative Commons v2.5 [http://creativecommons.org/licenses/by/2.5/](http://creativecommons.org/licenses/by/2.5/)