{"id":16706228,"url":"https://github.com/wikunia/brackets-quickdocsjs","last_synced_at":"2025-03-17T01:30:58.587Z","repository":{"id":14728088,"uuid":"17448836","full_name":"Wikunia/brackets-QuickDocsJS","owner":"Wikunia","description":"Inline short documentation for JavaScript functions, including a summary,syntax and parameters.","archived":false,"fork":false,"pushed_at":"2023-03-18T14:56:09.000Z","size":376,"stargazers_count":71,"open_issues_count":4,"forks_count":8,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-03-12T22:37:28.238Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Wikunia.png","metadata":{"files":{"readme":"Readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2014-03-05T17:29:30.000Z","updated_at":"2025-01-08T19:03:19.000Z","dependencies_parsed_at":"2024-10-27T11:50:41.046Z","dependency_job_id":"d887568f-054d-40d3-8d82-cf6aa08b648e","html_url":"https://github.com/Wikunia/brackets-QuickDocsJS","commit_stats":{"total_commits":86,"total_committers":1,"mean_commits":86.0,"dds":0.0,"last_synced_commit":"b2cc609296f761b4c2e6bc9a86c20501052e603b"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Wikunia%2Fbrackets-QuickDocsJS","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Wikunia%2Fbrackets-QuickDocsJS/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Wikunia%2Fbrackets-QuickDocsJS/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Wikunia%2Fbrackets-QuickDocsJS/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Wikunia","download_url":"https://codeload.github.com/Wikunia/brackets-QuickDocsJS/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243835942,"owners_count":20355611,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-12T19:34:14.823Z","updated_at":"2025-03-17T01:30:58.231Z","avatar_url":"https://github.com/Wikunia.png","language":"JavaScript","funding_links":["https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick\u0026hosted_button_id=B5VQXWCZXYN2W"],"categories":[],"sub_categories":[],"readme":"# QuickDocsJS\nThis extension provides a quick documentation for each JavaScript function.\nIt 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!\nYou don't use normal JS but jQuery or NodeJS? QuickDocs supports both of them (v1.5 \u0026 v1.6). \n\n**Miss some docs for standard functions or JS extensions like jQuery? Add them here [issue (#12)](../../issues/12). Thanks for your help!**\n\nQuickDocsJS makes it easy to read your JSDoc comments inline, but you have to write these comments...\n\n...Maybe you want to check out my [FuncDocr](https://github.com/Wikunia/brackets-FuncDocr) extension to generate JSDocs for your own functions.\n\n## You're rich?\nYou don't need a second yacht and have some coins to spend? Here I am :)\n\n[![Flattr this git repo](http://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=Wikunia\u0026url=https://github.com/Wikunia/brackets-QuickDocsJS\u0026title=Brackets-QuickDocsJS\u0026language=javascript\u0026tags=github\u0026category=software)\n[![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\u0026hosted_button_id=B5VQXWCZXYN2W)\n\n\n## Type Recognition Magic\n\nThe extension tries to get the correct documentation if the function is available for strings and arrays.\n\n```javascript\nvar abc = 'abc';\nvar pos = abc.indexOf('a'); // the documentation for String.indexOf \nvar parts = abc.split('');\npos = parts.indexOf('a'); // the documentation for Array.indexOf\n```\n\n## How to use\nYou 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.\n\n![Example](image/example.png?raw=true)\n\nThis 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.\n\nSince v1.6.0 QuickDocs supports jQuery! Thanks [http://api.jquery.com](http://api.jquery.com)\n\n## v 1.6.0\nSupport for jQuery!\n![jQuery](image/jQuery.png?raw=true)\n`@link`-tags are parsed as HTML links now and you can use them to jump easy between functions!\n\n## v 1.5.0\nSupport for NodeJS!\n![NodeJS](image/nodeJS.png?raw=true)\n\n## v 1.4.1\nQuickDocsJS can use require.js `define` statements to get docs by reading other modules.\n[#8](../../issues/8)\n\n\n## v 1.4\nQuickDocsJS supports prototype functions:\n```javascript\n/**\n * split a string into an array with limit entries\n * The last entry contains the last part of the string, which can contain the separator)\n * @param {String} separator string separator\n * @param {Integer} limit number of entries in the array\n * @return {Array} array of separated strings\n */\nString.prototype.splitLimit = function(separator,limit) {\n\tvar splitString = this;\n\tvar result = [];\n\tvar pos = splitString.search(separator);\n\tif (pos \u003c 0) return false;\n\tresult.push(splitString.substring(0,pos));\n\tresult.push(splitString.substring(pos+1));\n\treturn result;\n}\n\n\n```\n\n## v 1.2\nIt's now possible to get documentations for your own functions using JSDoc.\n```\n    /**\n        get the type of a variable\n        @param {String} content content of document\n        @param {String} variable name of the variable\n        @returns {String} type of the variable: unknown,String,Array or RegExp\n    */\n    function getVariableType (content, variable) {\n```\n\n![User functions](image/user_func.png?raw=true)\n\n\n\n##Languages\n+ English\n\n### License\nCreative Commons v2.5\n[http://creativecommons.org/licenses/by/2.5/](http://creativecommons.org/licenses/by/2.5/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwikunia%2Fbrackets-quickdocsjs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwikunia%2Fbrackets-quickdocsjs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwikunia%2Fbrackets-quickdocsjs/lists"}