{"_id":"gulp-jsdoc","_rev":"44-bdcb0fb89926d1db3c2eb3d8ab186b84","name":"gulp-jsdoc","description":"A jsdoc plugin for Gulp","dist-tags":{"latest":"0.1.5"},"versions":{"0.0.1":{"name":"gulp-jsdoc","version":"0.0.1","description":"A jsdoc plugin for Gulp","keywords":["gulpplugin","jsdoc","documentation","javascript","gulp"],"homepage":"https://github.com/jsBoot/gulp-jsdoc","bugs":{"url":"https://github.com/jsBoot/gulp-jsdoc/issues","email":"dev@webitup.fr"},"license":"MIT","author":{"name":"Mangled Deutz","email":"olivier@webitup.fr","url":"https://github.com/dmp42"},"contributors":[],"main":"./index.js","repository":{"type":"git","url":"git://github.com/jsBoot/gulp-jsdoc.git"},"scripts":{"test":"istanbul test _mocha --report html -- test/*.js --reporter spec","coveralls":"istanbul cover ./node_modules/mocha/bin/_mocha --report lcovonly -- -R spec && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js && rm -rf ./coverage"},"dependencies":{"through2":"~0.4.1","gulp-util":"~2.2.14","chalk":"~0.4.0","text-table":"~0.2.0","vinyl-fs":"0.0.2","jsdoc":"~3.3.0-alpha4","taffydb":"~2.7.2","ink-docstrap":"~0.3.0-0","wrench":"~1.5.6","marked":"~0.3.1"},"devDependencies":{"mocha":"1.17.1","coveralls":"~2.7.0","mocha-lcov-reporter":"~0.0.1","istanbul":"0.2.4","event-stream":"~3.1.0","should":"~3.1.2","eslint":"~0.3.0","jshint":"~2.4.3","gulp":"~3.5.1","gulp-template":"~0.1.1","gulp-jshint":"~1.3.4","gulp-eslint":"~0.1.2","jshint-stylish":"~0.1.5","eslint-stylish":"~0.2.0"},"engines":{"node":">=0.10.0","npm":">=1.0.0"},"_id":"gulp-jsdoc@0.0.1","dist":{"shasum":"43534a459a0538df1e5f059f37f1e6e2c78bd729","tarball":"https://registry.npmjs.org/gulp-jsdoc/-/gulp-jsdoc-0.0.1.tgz","integrity":"sha512-rNLo2lnrku4fclS7854YFP43O1WKsIvV/Ibp+vq8MuNJmQW1VOPazmM7lsjkRkcHTQYJZQPY60JffFGfjZYc6Q==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQC8D0jp0L7ifRoet7ZezpykNESZVW8cExvpWhVaWzDv0gIgCnxqPrYF8m70lD42LXQfCmSfy/kCS3XTkkTa0BnSKv0="}]},"_from":".","_npmVersion":"1.3.21","_npmUser":{"name":"dmp","email":"olivier@webitup.fr"},"maintainers":[{"name":"dmp","email":"olivier@webitup.fr"}],"deprecated":"This project is deprecated. Use gulp-jsdoc3 instead."},"0.0.2":{"name":"gulp-jsdoc","version":"0.0.2","description":"A jsdoc plugin for Gulp","keywords":["gulpplugin","jsdoc","documentation","javascript","gulp"],"homepage":"https://github.com/jsBoot/gulp-jsdoc","bugs":{"url":"https://github.com/jsBoot/gulp-jsdoc/issues","email":"dev@webitup.fr"},"license":"MIT","author":{"name":"Mangled Deutz","email":"olivier@webitup.fr","url":"https://github.com/dmp42"},"contributors":[],"main":"./index.js","repository":{"type":"git","url":"git://github.com/jsBoot/gulp-jsdoc.git"},"scripts":{"test":"istanbul test _mocha --report html -- test/*.js --reporter spec","coveralls":"istanbul cover ./node_modules/mocha/bin/_mocha --report lcovonly -- -R spec && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js && rm -rf ./coverage"},"dependencies":{"through2":"~0.4.1","gulp-util":"~2.2.14","chalk":"~0.4.0","text-table":"~0.2.0","vinyl-fs":"0.0.2","jsdoc":"~3.3.0-alpha4","taffydb":"~2.7.2","ink-docstrap":"~0.3.0-0","wrench":"~1.5.6","marked":"~0.3.1"},"devDependencies":{"mocha":"1.17.1","coveralls":"~2.7.0","mocha-lcov-reporter":"~0.0.1","istanbul":"0.2.4","event-stream":"~3.1.0","should":"~3.1.2","eslint":"~0.3.0","jshint":"~2.4.3","gulp":"~3.5.1","gulp-template":"~0.1.1","gulp-jshint":"~1.3.4","gulp-eslint":"~0.1.2","jshint-stylish":"~0.1.5","eslint-stylish":"~0.2.0"},"engines":{"node":">=0.10.0","npm":">=1.0.0"},"_id":"gulp-jsdoc@0.0.2","dist":{"shasum":"36747973c705a99e19bfb72f7c1c1191027453d7","tarball":"https://registry.npmjs.org/gulp-jsdoc/-/gulp-jsdoc-0.0.2.tgz","integrity":"sha512-XJr4JJuDz2inTnwZJKR0hwAUYUBjhzJklZ1mKKzZTUrKFgzOjdrd7n1BJR18OggM/PFD0taX1tNHVGvQBU1iQA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCICExqwjJwXylIBkUYdpMxHtGrscvFQbwfE8lqrSy/lCjAiEAqpPPf7TFR0fjydJ1De48WfypoGU1Wf0K/kgm+w8bQXc="}]},"_from":".","_npmVersion":"1.3.24","_npmUser":{"name":"dmp","email":"olivier@webitup.fr"},"maintainers":[{"name":"dmp","email":"olivier@webitup.fr"}],"deprecated":"This project is deprecated. Use gulp-jsdoc3 instead."},"0.1.0":{"name":"gulp-jsdoc","version":"0.1.0","description":"A jsdoc plugin for Gulp","keywords":["gulpplugin","jsdoc","documentation","javascript","gulp"],"homepage":"https://github.com/jsBoot/gulp-jsdoc","bugs":{"url":"https://github.com/jsBoot/gulp-jsdoc/issues","email":"dev@webitup.fr"},"license":"MIT","author":{"name":"Mangled Deutz","email":"olivier@webitup.fr","url":"https://github.com/dmp42"},"contributors":[],"main":"./index.js","repository":{"type":"git","url":"git://github.com/jsBoot/gulp-jsdoc.git"},"scripts":{"test":"istanbul test _mocha --report html -- test/*.js --reporter spec","coveralls":"istanbul cover ./node_modules/mocha/bin/_mocha --report lcovonly -- -R spec && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js && rm -rf ./coverage"},"dependencies":{"through2":"~0.4.1","gulp-util":"~2.2.14","chalk":"~0.4.0","text-table":"~0.2.0","vinyl-fs":"0.0.2","jsdoc":"~3.3.0-alpha4","taffydb":"~2.7.2","ink-docstrap":"~0.3.0-0","wrench":"~1.5.6","marked":"~0.3.1"},"devDependencies":{"mocha":"1.17.1","coveralls":"~2.7.0","mocha-lcov-reporter":"~0.0.1","istanbul":"0.2.4","event-stream":"~3.1.0","should":"~3.1.2","eslint":"~0.3.0","jshint":"~2.4.3","gulp":"~3.5.1","gulp-template":"~0.1.1","gulp-jshint":"~1.3.4","gulp-eslint":"~0.1.2","jshint-stylish":"~0.1.5","eslint-stylish":"~0.2.0"},"engines":{"node":">=0.10.0","npm":">=1.0.0"},"_id":"gulp-jsdoc@0.1.0","dist":{"shasum":"d14c02328e49d4d7c0b162b9f0afa004f85e301c","tarball":"https://registry.npmjs.org/gulp-jsdoc/-/gulp-jsdoc-0.1.0.tgz","integrity":"sha512-vUTAW9jv3vJ6Jl2sK31euPTK2IbKSw1cXve1DkNIS7sQTwz3Gm49VsXg82uVnMKdkyj0d2SUqBAsUO/7/TIN9A==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDVH1aXPl6LHDloZ5TJs4Xl/ebXBz08OKmSI6NCCgBd6QIhAIA4OztJ2ra8hZ9S3WUArwzpJk+MKYcM0Wvm52L2MuMR"}]},"_from":".","_npmVersion":"1.4.3","_npmUser":{"name":"dmp","email":"olivier@webitup.fr"},"maintainers":[{"name":"dmp","email":"olivier@webitup.fr"}],"deprecated":"This project is deprecated. Use gulp-jsdoc3 instead."},"0.1.1":{"name":"gulp-jsdoc","version":"0.1.1","description":"A jsdoc plugin for Gulp","keywords":["gulpplugin","jsdoc","documentation","javascript","gulp"],"homepage":"https://github.com/jsBoot/gulp-jsdoc","bugs":{"url":"https://github.com/jsBoot/gulp-jsdoc/issues","email":"dev@webitup.fr"},"license":"MIT","author":{"name":"Mangled Deutz","email":"olivier@webitup.fr","url":"https://github.com/dmp42"},"contributors":[],"main":"./index.js","repository":{"type":"git","url":"git://github.com/jsBoot/gulp-jsdoc.git"},"scripts":{"test":"istanbul test _mocha --report html -- test/*.js --reporter spec","coveralls":"istanbul cover ./node_modules/mocha/bin/_mocha --report lcovonly -- -R spec && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js && rm -rf ./coverage"},"dependencies":{"through2":"~0.4.1","gulp-util":"~2.2.14","chalk":"~0.4.0","text-table":"~0.2.0","vinyl-fs":"0.0.2","jsdoc":"~3.3.0-alpha5","taffydb":"~2.7.2","ink-docstrap":"~0.3.0-0","wrench":"~1.5.6","marked":"~0.3.1"},"devDependencies":{"mocha":"1.17.1","coveralls":"~2.7.0","mocha-lcov-reporter":"~0.0.1","istanbul":"0.2.4","event-stream":"~3.1.0","should":"~3.1.2","eslint":"~0.3.0","jshint":"~2.4.3","gulp":"~3.5.1","gulp-template":"~0.1.1","gulp-jshint":"~1.3.4","gulp-eslint":"~0.1.2","jshint-stylish":"~0.1.5","eslint-stylish":"~0.2.0"},"engines":{"node":">=0.10.0","npm":">=1.0.0"},"private":false,"_id":"gulp-jsdoc@0.1.1","dist":{"shasum":"fdd5cda525d7da1dd79298c6470956e2a1bb0715","tarball":"https://registry.npmjs.org/gulp-jsdoc/-/gulp-jsdoc-0.1.1.tgz","integrity":"sha512-cw1v9mcgMFDm/cpuveJE3U3oVsaF/WWAiN9BFjktl4gjy1G6E83rIHzUmPQMpioIivK59RqytEcCujzyNTdYQg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFuJSmbaXGfe//xDH5SdYftZat6EKWKKW2SUfX1SRUmvAiEA9VbKcC2Rh6+c9/2mdVaswQV+lFUxI+ZqRMokMXdv+k0="}]},"_from":".","_npmVersion":"1.4.3","_npmUser":{"name":"dmp","email":"olivier@webitup.fr"},"maintainers":[{"name":"dmp","email":"olivier@webitup.fr"}],"deprecated":"This project is deprecated. Use gulp-jsdoc3 instead."},"0.1.2":{"name":"gulp-jsdoc","version":"0.1.2","description":"A jsdoc plugin for Gulp","keywords":["gulpplugin","jsdoc","documentation","javascript","gulp"],"homepage":"https://github.com/jsBoot/gulp-jsdoc","bugs":{"url":"https://github.com/jsBoot/gulp-jsdoc/issues","email":"dev@webitup.fr"},"license":"MIT","author":{"name":"Mangled Deutz","email":"olivier@webitup.fr","url":"https://github.com/dmp42"},"contributors":[],"main":"./index.js","repository":{"type":"git","url":"git://github.com/jsBoot/gulp-jsdoc.git"},"scripts":{"test":"istanbul test _mocha --report html -- test/*.js --reporter spec","coveralls":"istanbul cover ./node_modules/mocha/bin/_mocha --report lcovonly -- -R spec && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js && rm -rf ./coverage"},"dependencies":{"through2":"~0.4.1","gulp-util":"~2.2.14","chalk":"~0.4.0","text-table":"~0.2.0","vinyl-fs":"0.0.2","jsdoc":"3.3.0-alpha5","taffydb":"~2.7.2","ink-docstrap":"~0.3.0-0","wrench":"~1.5.6","marked":"~0.3.1"},"devDependencies":{"mocha":"1.17.1","coveralls":"~2.7.0","mocha-lcov-reporter":"~0.0.1","istanbul":"0.2.4","event-stream":"~3.1.0","should":"~3.1.2","eslint":"~0.3.0","jshint":"~2.4.3","gulp":"~3.5.1","gulp-template":"~0.1.1","gulp-jshint":"~1.3.4","gulp-eslint":"~0.1.2","jshint-stylish":"~0.1.5","eslint-stylish":"~0.2.0"},"engines":{"node":">=0.10.0","npm":">=1.0.0"},"private":false,"_id":"gulp-jsdoc@0.1.2","dist":{"shasum":"77acfa2da087342fa4777d9eb3095b81072a23b3","tarball":"https://registry.npmjs.org/gulp-jsdoc/-/gulp-jsdoc-0.1.2.tgz","integrity":"sha512-MBB+SuSyKVYLMuCvfbwhN9X4vYWaHitu5y7SjtI+icM/eOQwQYkVUs12C/fDF5fe2J4kloUbMfn6MvH7u3cMlQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDi7yCWAQraaVerj5CtDQ118HzZPyEpAwmiaQp717VhwAIgVgwwC7LKITe4U4JpI99T4uLwbdegINfYejnySmRhVH4="}]},"_from":".","_npmVersion":"1.4.3","_npmUser":{"name":"dmp","email":"olivier@webitup.fr"},"maintainers":[{"name":"dmp","email":"olivier@webitup.fr"}],"deprecated":"This project is deprecated. Use gulp-jsdoc3 instead."},"0.1.3":{"name":"gulp-jsdoc","version":"0.1.3","description":"A jsdoc plugin for Gulp","keywords":["gulpplugin","jsdoc","documentation","javascript","gulp"],"homepage":"https://github.com/jsBoot/gulp-jsdoc","bugs":{"url":"https://github.com/jsBoot/gulp-jsdoc/issues","email":"dev@webitup.fr"},"license":"MIT","author":{"name":"Mangled Deutz","email":"olivier@webitup.fr","url":"https://github.com/dmp42"},"contributors":[],"main":"./index.js","repository":{"type":"git","url":"git://github.com/jsBoot/gulp-jsdoc.git"},"scripts":{"test":"istanbul test _mocha --report html -- test/*.js --reporter spec","coveralls":"istanbul cover ./node_modules/mocha/bin/_mocha --report lcovonly -- -R spec && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js && rm -rf ./coverage"},"dependencies":{"through2":"~0.4.1","gulp-util":"~2.2.14","chalk":"~0.4.0","text-table":"~0.2.0","vinyl-fs":"0.0.2","jsdoc":"3.3.0-alpha5","taffydb":"~2.7.2","ink-docstrap":"~0.3.0-0","wrench":"~1.5.6","marked":"~0.3.1"},"devDependencies":{"mocha":"1.17.1","coveralls":"~2.7.0","mocha-lcov-reporter":"~0.0.1","istanbul":"0.2.4","event-stream":"~3.1.0","should":"~3.1.2","eslint":"~0.3.0","jshint":"~2.4.3","gulp":"~3.5.1","gulp-template":"~0.1.1","gulp-jshint":"~1.3.4","gulp-eslint":"~0.1.2","jshint-stylish":"~0.1.5","eslint-stylish":"~0.2.0"},"engines":{"node":">=0.10.0","npm":">=1.0.0"},"private":false,"_id":"gulp-jsdoc@0.1.3","dist":{"shasum":"1e547165b3f9e77f9d290a47d3ace00364f144cf","tarball":"https://registry.npmjs.org/gulp-jsdoc/-/gulp-jsdoc-0.1.3.tgz","integrity":"sha512-6VJElFhtPsbRNkSBHt/e8qTK29ui205IK9zsfxUsVhyoW4xQC5dvPTun1Ye4odnV0HG8GSU+CHV8O3uBWDuCCA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQClJrkMNUK3ZvBUJTxNDz2uR8qlRrIjS/h0uyAC9gw7bQIgJ/IKILdEDnbDxa9i+SzXMwURhTliZbHMgNGcib0vE/I="}]},"_from":".","_npmVersion":"1.4.3","_npmUser":{"name":"dmp","email":"olivier@webitup.fr"},"maintainers":[{"name":"dmp","email":"olivier@webitup.fr"}],"deprecated":"This project is deprecated. Use gulp-jsdoc3 instead."},"0.1.4":{"name":"gulp-jsdoc","version":"0.1.4","description":"A jsdoc plugin for Gulp","keywords":["gulpplugin","jsdoc","documentation","javascript","gulp"],"homepage":"https://github.com/jsBoot/gulp-jsdoc","bugs":{"url":"https://github.com/jsBoot/gulp-jsdoc/issues","email":"dev@webitup.fr"},"license":"MIT","author":{"name":"Mangled Deutz","email":"olivier@webitup.fr","url":"https://github.com/dmp42"},"contributors":[],"main":"./index.js","repository":{"type":"git","url":"git://github.com/jsBoot/gulp-jsdoc.git"},"scripts":{"test":"istanbul test _mocha --report html -- test/*.js --reporter spec","coveralls":"istanbul cover ./node_modules/mocha/bin/_mocha --report lcovonly -- -R spec && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js && rm -rf ./coverage"},"dependencies":{"through2":"~0.4.1","gulp-util":"~2.2.14","chalk":"~0.4.0","text-table":"~0.2.0","vinyl-fs":"~0.1.2","jsdoc":"3.3.0-alpha5","taffydb":"~2.7.2","ink-docstrap":"~0.3.0-0","wrench":"~1.5.6","marked":"~0.3.1"},"devDependencies":{"mocha":"1.17.1","coveralls":"~2.7.0","mocha-lcov-reporter":"~0.0.1","istanbul":"0.2.4","event-stream":"~3.1.0","should":"~3.1.2","eslint":"~0.3.0","jshint":"~2.4.3","gulp":"~3.5.1","gulp-template":"~0.1.1","gulp-jshint":"~1.3.4","gulp-eslint":"~0.1.2","jshint-stylish":"~0.1.5","eslint-stylish":"~0.2.0"},"engines":{"node":">=0.10.0","npm":">=1.0.0"},"private":false,"_id":"gulp-jsdoc@0.1.4","dist":{"shasum":"0384d01a4b35790915c296056ff46a90ce4df581","tarball":"https://registry.npmjs.org/gulp-jsdoc/-/gulp-jsdoc-0.1.4.tgz","integrity":"sha512-/vsuqRLEX0cAjpNI0PFKhcsjSlBrLmYgIHQjEjz0uBUZIbYsiaBIzeLfAXJv7KzF0ggmcD1xqWMAtz7TNejcOw==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIF8DYKKt7NXUa4DLOf5uCVpgDflfnKTWv1wnEsJ8SyX+AiEAnK9u/D6cf0PJD82pZIl53sPpm0UBs+VXxST3BZ+2HDI="}]},"_from":".","_npmVersion":"1.4.3","_npmUser":{"name":"dmp","email":"olivier@webitup.fr"},"maintainers":[{"name":"dmp","email":"olivier@webitup.fr"}],"deprecated":"This project is deprecated. Use gulp-jsdoc3 instead."},"0.1.5":{"name":"gulp-jsdoc","version":"0.1.5","description":"A jsdoc plugin for Gulp","keywords":["gulpplugin","jsdoc","documentation","javascript","gulp"],"homepage":"https://github.com/jsBoot/gulp-jsdoc","bugs":{"url":"https://github.com/jsBoot/gulp-jsdoc/issues","email":"dev@webitup.fr"},"license":"MIT","author":{"name":"Mangled Deutz","email":"olivier@webitup.fr","url":"https://github.com/dmp42"},"contributors":[],"main":"./index.js","repository":{"type":"git","url":"git://github.com/jsBoot/gulp-jsdoc.git"},"scripts":{"test":"istanbul test _mocha --report html -- test/*.js --reporter spec","coveralls":"istanbul cover ./node_modules/mocha/bin/_mocha --report lcovonly -- -R spec && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js && rm -rf ./coverage"},"dependencies":{"through2":"^1.0.0","gulp-util":"~2.2.14","chalk":"~0.4.0","text-table":"~0.2.0","vinyl-fs":"~0.3.0","jsdoc":"3.3.0-alpha5","taffydb":"~2.7.2","ink-docstrap":"~0.4.5","wrench":"~1.5.6","marked":"~0.3.1"},"devDependencies":{"mocha":"^1.17.1","coveralls":"^2.7.1","mocha-lcov-reporter":"~0.0.1","istanbul":"^0.2.4","event-stream":"~3.1.0","should":"^3.1.4","jshint":"^2.4.4","gulp":"^3.5.6","gulp-template":"~0.1.1","gulp-jshint":"^1.3.4","gulp-eslint":"~0.1.2","jshint-stylish":"^0.1.5"},"engines":{"node":">=0.10.0","npm":">=1.0.0"},"private":false,"gitHead":"8a6d325c354237e1a69019fb7b19f3790cdbde04","_id":"gulp-jsdoc@0.1.5","_shasum":"c79e06f9bdeb868a3e096fa56da037110d998455","_from":".","_npmVersion":"2.14.5","_nodeVersion":"0.12.7","_npmUser":{"name":"indexzero","email":"charlie.robbins@gmail.com"},"maintainers":[{"name":"dmp","email":"olivier@webitup.fr"},{"name":"indexzero","email":"charlie.robbins@gmail.com"}],"dist":{"shasum":"c79e06f9bdeb868a3e096fa56da037110d998455","tarball":"https://registry.npmjs.org/gulp-jsdoc/-/gulp-jsdoc-0.1.5.tgz","integrity":"sha512-SC2HA41li2EzCZBgpwP92WFSZHy0RgtVNPmxmc/zVgOFqCcL1YaXVe+V241SxhOLpkCdSHPYwgTF90jq8fFrQQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIG3Kc6qHLhQX2WkLrrp+QbmCBSPvFL6dXyHS+QGcXtYQAiEAjjdInq8SsXv0lvqS6eRho2GhvdE/1pb9K9XpScMSnng="}]},"deprecated":"This project is deprecated. Use gulp-jsdoc3 instead."}},"readme":"# gulp-jsdoc\n[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url]  [![Coverage Status][coveralls-image]][coveralls-url] [![Dependency Status][depstat-image]][depstat-url] [![Code Climate][codeclimate-image]][codeclimate-url]\n\n> jsdoc plugin for [gulp](https://github.com/wearefractal/gulp)\n\nBIG FAT WARNING\n-------------\n\njsdoc is currently (alpha5+) going through important inner modifications.\nAlso, jsdoc has an history at doing quesitonable things (certainly, at least in part, due to its desire to support alternative javascript engines like Rhino), including, not limited to, hard copying files into the module folder at runtime (templates), and using non standard require calls and paths.\nFinally, jsdoc really is not meant to be used as a library. It provides a cli, and little more, with no clean/stable library API.\n\nAll in all, maintaining a working \"true\" gulp plugin (one that uses streams and does not simply call a binary) proved to be a very painful task, with ultimately little benefit, as I stopped using jsdoc altogether for my own uses.\n\nFor all these reasons, I decided to stop maintaining this plugin, and won't work on it until at least a new jsdoc stable version is released.\nIf you still use it and have a PR, I'll review it though.\n\nTL;DR\n-------------\n\nInstall `gulp-jsdoc` as a development dependency:\n\n```shell\nnpm install --save-dev gulp-jsdoc\n```\n\nThen, use it:\n\n```javascript\nvar jsdoc = require(\"gulp-jsdoc\");\n\ngulp.src(\"./src/*.js\")\n  .pipe(jsdoc('./documentation-output'))\n```\n\nAPI\n-------------\n\n### jsdoc.parser(infos, name)\n\n```javascript\ngulp.src(\"./src/*.js\")\n  .pipe(jsdoc.parser(infos, name))\n  .pipe(gulp.dest('./somewhere'))\n```\n\nWill process any files it has been fed, and generate a new vinyl JSON usable by the generator to produce actual documentation.\n\nBy default, the filename is 'jsdoc.json' unless overriden by the name parameter.\n\nNote that if you feed the parser a README.md file, this file will be rendered and used as a long description for your package.\n\neg:\n\n```javascript\ngulp.src([\"./src/*.js\", \"README.md\"])\n  .pipe(jsdoc.parser(infos, name))\n  .pipe(gulp.dest('./somewhere'))\n```\n\nThe optional infos parameter is fed to jsdoc.\n\n#### infos.name\nType: `String`  \nDefault: `''`\n\n#### infos.description\nType: `String`  \nDefault: `''`\n\n#### infos.version\nType: `String`  \nDefault: `''`\n\n#### infos.licenses\nType: `Array`  \nDefault: `[]`\n\n#### infos.plugins\nType: `Array`  \nDefault: `false`\n\njsDoc plugins to use. Example: `['plugins/markdown']`\n\n\n### jsdoc.generator(destination, template, options)\n\n```javascript\ngulp.src(\"./somewhere/jsdoc.json\")\n  .pipe(jsdoc.generator('./destination'))\n```\n\nor directly from the parser pipe:\n\n```javascript\ngulp.src([\"./src/*.js\", \"README.md\"])\n  .pipe(jsdoc.parser(infos, name))\n  .pipe(jsdoc.generator('./destination'))\n```\n\nBy default, the generator uses the default template.\n\n#### destination\nType: `String`  \nDefault: `''`\n\nWhere the documentation will be outputed.\nIf an infos object with a version / name was provided to the parser, these will be used in the final path.\n\n#### template\n\nYou may optionnally specify a custom template, using the following syntax\n\n```\n{\n  path: 'path_to_template',\n  anyTemplateSpecificParameter: 'whatever'\n}\n```\n\nAs a courtesy, gulp-jsdoc bundles ink-docstrap templates, that you may use directly this way:\n\n```\n{\n    path            : \"ink-docstrap\",\n    systemName      : \"Something\",\n    footer          : \"Something\",\n    copyright       : \"Something\",\n    navType         : \"vertical\",\n    theme           : \"journal\",\n    linenums        : true,\n    collapseSymbols : false,\n    inverseNav      : false\n  }\n```\n\nSee [their site](https://github.com/terryweiss/docstrap) for more infos.\n\n\n#### options\n\nYou may optionnally override default jsdoc behavior with this object:\n\n```\n  {\n    showPrivate: false,\n    monospaceLinks: false,\n    cleverLinks: false,\n    outputSourceFiles: true\n  }\n ```\n\n\n### jsdoc(destination, template, infos, options)\n\n```javascript\ngulp.src([\"./src/*.js\", \"README.md\"])\n  .pipe(jsdoc('./destination'))\n```\n\n... is simply a shortcut for\n\n```javascript\ngulp.src([\"./src/*.js\", \"README.md\"])\n  .pipe(jsdoc.parser())\n  .pipe(jsdoc.generator('./destination'))\n```\n\n\nLimitations\n-------------\n\nOnly the parser is really using streams. While the generator will read from the result of the parser, it will also read and write templates files synchronously on its own.\n\nThere is nothing we can do about that, unless changing the jsdoc templating API entirely, and all existing templates...\n\nAlso, the following are currently not supported:\n\n * tutorials\n * sourcing configuration from jsdoc.conf files\n\nIf you have a use-case that you can't do with straight gulp in a better way, please say so.\n\nLicense\n-------------\n\n[MIT License](http://en.wikipedia.org/wiki/MIT_License)\n\n[npm-url]: https://npmjs.org/package/gulp-jsdoc\n[npm-image]: https://badge.fury.io/js/gulp-jsdoc.png\n\n[travis-url]: http://travis-ci.org/jsBoot/gulp-jsdoc\n[travis-image]: https://secure.travis-ci.org/jsBoot/gulp-jsdoc.png?branch=master\n\n[coveralls-url]: https://coveralls.io/r/jsBoot/gulp-jsdoc\n[coveralls-image]: https://coveralls.io/repos/jsBoot/gulp-jsdoc/badge.png?branch=master\n\n[depstat-url]: https://david-dm.org/jsBoot/gulp-jsdoc\n[depstat-image]: https://david-dm.org/jsBoot/gulp-jsdoc.png\n\n[codeclimate-url]: https://codeclimate.com/github/jsBoot/gulp-jsdoc\n[codeclimate-image]: https://codeclimate.com/github/jsBoot/gulp-jsdoc.png\n","maintainers":[{"name":"dmp","email":"olivier@webitup.fr"},{"name":"indexzero","email":"charlie.robbins@gmail.com"}],"time":{"modified":"2022-06-18T17:22:28.197Z","created":"2014-02-05T17:24:19.485Z","0.0.1":"2014-02-05T17:24:19.485Z","0.0.2":"2014-02-12T14:08:53.872Z","0.1.0":"2014-03-05T15:41:31.285Z","0.1.1":"2014-03-26T20:25:30.975Z","0.1.2":"2014-03-31T07:19:27.162Z","0.1.3":"2014-04-11T18:35:00.949Z","0.1.4":"2014-04-16T07:10:00.103Z","0.1.5":"2015-10-02T18:20:27.004Z"},"readmeFilename":"README.md","homepage":"https://github.com/jsBoot/gulp-jsdoc","keywords":["gulpplugin","jsdoc","documentation","javascript","gulp"],"repository":{"type":"git","url":"git://github.com/jsBoot/gulp-jsdoc.git"},"contributors":[],"author":{"name":"Mangled Deutz","email":"olivier@webitup.fr","url":"https://github.com/dmp42"},"bugs":{"url":"https://github.com/jsBoot/gulp-jsdoc/issues","email":"dev@webitup.fr"},"license":"MIT","users":{"t1st3":true,"jkinman":true,"evan2x":true,"joaocunha":true,"samhou1988":true,"itonyyo":true,"baskaal":true,"gejiawen":true,"rethinkflash":true,"santihbc":true,"edwin_estrada":true,"sopepos":true,"animabear":true,"pandao":true,"davidazullo":true,"bian17888":true,"bwade231":true,"rubiadias":true,"elussich":true,"king.v":true,"walnut":true,"advence-liz":true}}